​

ves-io-schema-shape-data_delivery-CustomAPI-LoadExecutiveSummary

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing data_delivery CustomAPI LoadExecutiveSummary

Usecase:

Load Executive Summary

Request:

Request using vesctl:

vesctl request rpc data_delivery.CustomAPI.LoadExecutiveSummary -i request.yaml --uri /public/namespaces/system/di/summary --http-method POST

where file request.yaml has following contents:

anomalousScorePercentile: 99.9
flowLabels:
- flowLabel: Login
  platform: Linux
granularity: 5m
namespace: system
platform: linux
timeRange: 1h
timestamp: "1740047311528"

vesctl yaml response:

eventsReasons:
- category: bot
  eventsCount: 245
  eventsPercentage: 100
  reason: High Login Count
lineChartData:
  granularity: 5m
  series:
  - data:
    - timestamp: "1740047311528"
      value: 24.2
    name: Test Series
summary:
  anomalousMaxScore: 10
  botPercentage: 10
  botTransactions: 1
  totalEvaluatedDevices: 24
  totalEvaluatedTransactions: 10

Request using curl:

curl -X 'POST' -d '{"namespace":"system","timestamp":"1740047311528","anomalousScorePercentile":99.9,"timeRange":"1h","granularity":"5m","flowLabels":[{"flowLabel":"Login","platform":"Linux"}],"platform":"linux"}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/data-intelligence/namespaces/system/di/summary'

curl response:

HTTP/1.1 200 OK
Content-Length: 721
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:28:49 GMT
Vary: Accept-Encoding


{
  "summary": {
    "totalEvaluatedTransactions": 10,
    "totalEvaluatedDevices": 24,
    "botTransactions": 1,
    "botPercentage": 10,
    "anomalousTransactions": 0,
    "anomalousPercentage": 0,
    "anomalousDevices": 0,
    "anomalousDevicesPercentage": 0,
    "anomalousMaxScore": 10,
    "anomalousMinScore": 0
  },
  "lineChartData": {
    "granularity": "5m",
    "series": [
      {
        "name": "Test Series",
        "data": [
          {
            "timestamp": "1740047311528",
            "value": 24.2
          }
        ]
      }
    ]
  },
  "eventsReasons": [
    {
      "category": "bot",
      "reason": "High Login Count",
      "eventsCount": 245,
      "eventsPercentage": 100
    }
  ]
}
On this page: