​

ves-io-schema-shape-bot_defense-reporting-CustomAPI-TrafficOverviewV2

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

Examples of performing reporting CustomAPI TrafficOverviewV2

Usecase:

TrafficOverviewV2 for vh1 in ns1,

Request:

Request using vesctl:

vesctl request rpc reporting.CustomAPI.TrafficOverviewV2 -i request.yaml --uri /public/namespaces/ns1/v2/reporting/traffic/overview --http-method POST

where file request.yaml has following contents:

namespace: ns1
virtualHost: vh1

vesctl yaml response:

{}

Request using curl:

curl -X 'POST' -d '{"namespace":"ns1","virtual_host":"vh1"}' -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/shape/bot/namespaces/ns1/v2/reporting/traffic/overview'

curl response:

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


{
  "human": "0",
  "malicious_bot": "0",
  "total": "0",
  "good_bot": "0",
  "others": "0",
  "human_previous": "0",
  "malicious_bot_previous": "0",
  "good_bot_previous": "0",
  "others_previous": "0",
  "total_previous": "0",
  "good_bot_percentage": 0,
  "malicious_bot_percentage": 0,
  "human_percentage": 0,
  "others_percentage": 0,
  "total_sentiment": "",
  "malicious_bot_sentiment": "",
  "human_sentiment": "",
  "good_bot_sentiment": "",
  "human_trend": null,
  "bot_trend": null,
  "good_bot_trend": null,
  "others_trend": null,
  "total_trend": null
}
On this page: