Skip to content
API Enriched

Traffic Overview Timeseries V4.

POST
/api/shape/bot/namespaces/{namespace}/v4/reporting/traffic/overview/timeseries
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/namespaces/example/v4/reporting/traffic/overview/timeseries \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "category": "example", "end_time": "example", "filters": { "global_filters": [ { "key": "TIMESTAMP", "op": "IN", "values": [ "example" ] } ], "region_filter": "US" }, "namespace": "example", "start_time": "example", "use_raw_data": true }'

GET the traffic count details based on types like Humans, Automated, Allow listed, etc. Over a chosen period.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace

x-required namespace is used to scope the query. Only virtual_host in given namespace will be considered.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
TrafficOverviewV2Request

Request for Shape Bot Defense traffic overview with global filters.

object
category
Category

Endpoint category label Optional: empty by default.

string
<= 128 characters
end_time
End time

End time of the query period Format: unix_timestamp|RFC 3339

Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to

string
<= 1024 characters
filters
object
global_filters
Filters

List of global filters

Required: YES.

Array<object>
Global Filter

Query Global Filter.

object
key
string
default: TIMESTAMP
Allowed values: TIMESTAMP USERNAME CLIENT_TOKEN IP_ADDRESS ASN AS_ORGANIZATION COUNTRY METHOD HOST PATH URL REFERER TRAFFIC_CHANNEL IS_ATTACK BOT_REASON TRAFFIC_TYPE THREAT_TYPE SDK_VERSION ACTION_TAKEN COOKIE_AGE BOT_COOKIE USER_AGENT USER_AGENT_OS_FAMILY USER_AGENT_FAMILY BROWSER_FINGERPRINT USER_FINGERPRINT HEADER_FINGERPRINT DEVICE_ID FLOW AGENT APPLICATION_NAME PROTECTED_APPLICATION RESPONSE_CODE SERVER_RESPONSE_CODE TRANSACTION_RESULT MOBILE_TRANSACTION_INSIGHT WEB_TRANSACTION_INSIGHT TRIGGERED_RULE FLOW_CATEGORY FLOW_LABEL
op
string
default: IN
Allowed values: IN NOT_IN MATCHES_REGEX DOES_NOT_MATCH_REGEX INCLUDES DOES_NOT_INCLUDE STARTS_WITH ENDS_WITH
values
Values

An unordered list of filter strings Required: YES.

Array<string>
>= 1 items <= 64 items
region_filter
string
default: US
Allowed values: US EU ASIA CA
namespace
Namespace

Namespace is used to scope the query. Only virtual_host in given namespace will be considered. Required: YES.

string
>= 6 characters <= 1024 characters
start_time
Start time

Start time of the query period Format: unix_timestamp|RFC 3339

Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.

string
<= 1024 characters
use_raw_data
Use raw data

Optional: by default is false.

boolean format: boolean

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
TrafficOverviewTimeseriesV2Response

Response that contains Shape Bot Defense traffic type timeseries.

object
traffic_type_data
Traffic Type Data

Traffic type timeseries.

Array<object>
TimeSeriesGraphMinimalData

Response that contains timeseries against each traffic or any other type.

object
name
Name

The name of the Traffic Type.

string
>= 6 characters <= 1024 characters
time_series
Timeseries Values

Time Series data for each traffic type.

Array<object>
Requests Time Series

Requests over time.

object
count
Number of Requests

Number of requests counted at specific time period marked by timestamp.

string format: uint64
<= 1024 characters
timestamp
Timestamp

UTC timestamp in seconds.

number format: double
Examplegenerated
{
  "traffic_type_data": [
    {
      "name": "example",
      "time_series": [
        {
          "count": "example",
          "timestamp": 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