Skip to content
API Enriched

Load Executive Summary.

POST
/api/data-intelligence/namespaces/{namespace}/di/summary
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data-intelligence/namespaces/example/di/summary \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "anomalousScorePercentile": 1, "flowLabels": [ { "flowLabel": "example", "platform": "example" } ], "granularity": "example", "namespace": "example", "platform": "example", "timeRange": "example", "timestamp": "example" }'

Executive summary page for DI premium customers.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace in which the suggestions are scoped.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
LoadExecutiveSummaryRequest

Request object to GET executive summary of DI premium customer.

object
anomalousScorePercentile
AnomalousScorePercentile

Percentile of anomalous score.

number format: double
flowLabels
FlowLabels

FlowLabel for filtering the data.

Array<object>
FlowLabel

Message representing flow label information.

object
flowLabel
FlowLabel

FlowLabel for filtering the data.

string
<= 1024 characters
platform
Platform

Platform for filtering the data.

string
<= 1024 characters
granularity
Granularity

Granularity of the data points (“1m”, “5m”, etc.)

string
<= 1024 characters
namespace
namespace

Namespace in which the suggestions are scoped.

string
>= 6 characters <= 1024 characters
platform
Platform

Platform criteria for filtering the data.

string
<= 1024 characters
timeRange
TimeRange

Time range (“1h”, “7d”, etc.)

string
<= 1024 characters
timestamp
Timestamp

Unix timestamp (seconds since epoch)

string format: int64
<= 1024 characters
Examplegenerated
{
  "anomalousScorePercentile": 1,
  "flowLabels": [
    {
      "flowLabel": "example",
      "platform": "example"
    }
  ],
  "granularity": "example",
  "namespace": "example",
  "platform": "example",
  "timeRange": "example",
  "timestamp": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
LoadExecutiveSummaryResponse

Response object to GET executive summary of DI premium customer.

object
eventsReasons
EventsReason

Message representing the transaction data.

Array<object>
EventsReason

Message object representing events reason.

object
category
Category

String representing event category.

string
<= 1024 characters
eventsCount
EventsCount

Number of such events.

integer format: int64
eventsPercentage
EventsPercentage

Number of such events percentage.

number format: double
reason
Reason

String representing event reason.

string
>= 27 characters <= 1024 characters
lineChartData
object
granularity
Granularity

Granularity of the data points (“1m”, “5m”, etc.)

string
<= 1024 characters
series
Series

Array of data series.

Array<object>
Series

Message object representing series.

object
data
DataPoint

Array of data points.

Array<object>
DataPoint

Message object representing data point.

object
timestamp
Timestamp

Unix timestamp (seconds since epoch)

string format: int64
<= 1024 characters
value
Value

Value at the given timestamp.

number format: double
>= 3 characters <= 15 characters
name
Name

Name of the series (“typical”, “bot”, “anomalous”)

string
>= 6 characters <= 1024 characters
summary
object
anomalousDevices
AnomalousDevices

Number of devices identified as anomalous.

integer format: int64
anomalousDevicesPercentage
AnomalousDevicesPercentage

Percentage of anomalous devices over total evaluated devices.

number format: double
anomalousMaxScore
AnomalousMaxScore

Max anomalous score.

number format: double
anomalousMinScore
AnomalousMinScore

Min anomalous score.

number format: double
anomalousPercentage
AnomalousPercentage

Percentage of anomalous transactions over total evaluated transactions.

number format: double
anomalousTransactions
anomalousTransactions

Number of transactions identified as anomalous.

integer format: int64
botPercentage
BotPercentage

Percentage of bot transactions over total evaluated transactions.

number format: double
botTransactions
BotTransactions

Number of transactions identified as bots.

integer format: int64
totalEvaluatedDevices
TotalEvaluatedDevices

Total number of evaluated devices.

integer format: int64
totalEvaluatedTransactions
TotalEvaluatedTransactions

Total number of evaluated transactions.

integer format: int64
Examplegenerated
{
  "eventsReasons": [
    {
      "category": "example",
      "eventsCount": 1,
      "eventsPercentage": 1,
      "reason": "example"
    }
  ],
  "lineChartData": {
    "granularity": "example",
    "series": [
      {
        "data": [
          {
            "timestamp": "example",
            "value": 1
          }
        ],
        "name": "example"
      }
    ]
  },
  "summary": {
    "anomalousDevices": 1,
    "anomalousDevicesPercentage": 1,
    "anomalousMaxScore": 1,
    "anomalousMinScore": 1,
    "anomalousPercentage": 1,
    "anomalousTransactions": 1,
    "botPercentage": 1,
    "botTransactions": 1,
    "totalEvaluatedDevices": 1,
    "totalEvaluatedTransactions": 1
  }
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example