Skip to content
API Enriched

Known Bot Endpoint.

POST
/api/shape/bot/namespaces/{namespace}/v1/reporting/traffic/known/dimension/endpoint
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/v1/reporting/traffic/known/dimension/endpoint \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "filters": { "global_filters": [ { "key": "TIMESTAMP", "op": "IN", "values": [ "example" ] } ], "region_filter": "US" }, "limit": 1, "namespace": "example", "pagination": { "page_number": 1, "page_size": 1 }, "request_metrics": [ "example" ], "sort_options": [ { "key": "TIMESTAMP", "order": "DESCENDING" } ], "start_time": "example", "time_bucket_size": "example" }'

GET Known Bot Endpoint.

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
Known Bot Request

Known Bot Request.

object
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.

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 ENDPOINT_NAME ENDPOINT_LABEL BOT_ENDPOINT_POLICY KNOWN_BOT_NAME KNOWN_BOT_CATEGORY KNOWN_BOT_PROVIDER KNOWN_BOT_CATEGORY_TYPE KNOWN_BOT_MITIGATION ABSOLUTE PERCENTAGE TREND ENDPOINT_POLICY
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.

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

Limits the number of transactions returned in the response Optional: If not specified, the first 500 transactions that matches the query will be returned in the response. The maximum value for limit is 500.

integer format: int64
namespace
Namespace

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

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
pagination
object
page_number
Page Number

Configuration parameter for page number

integer format: int64
page_size
Page Size

Size or capacity specification

integer format: int64
request_metrics
Request Metrics

Optional, list of metric identifiers to retrieve.

Array<string>
sort_options
Sort Option

Sort OPTIONS for the query result. If unspecified, sort is by count, in descending order.

Array<object>
Sort Option

Query Result Sort Option.

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 ENDPOINT_NAME ENDPOINT_LABEL BOT_ENDPOINT_POLICY KNOWN_BOT_NAME KNOWN_BOT_CATEGORY KNOWN_BOT_PROVIDER KNOWN_BOT_CATEGORY_TYPE KNOWN_BOT_MITIGATION ABSOLUTE PERCENTAGE TREND ENDPOINT_POLICY
order
string
default: DESCENDING
Allowed values: DESCENDING ASCENDING
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
time_bucket_size
Time Bucket Size

ISO 8601 duration, e.g. “PT5M” = 5 minutes, “PT1H” = 1 hour, “P1D” = 1 day.

Optional: If specified, timeseries style APIs should use this as the bucket size. If not specified, the backend will automatically choose an appropriate bucket size based on start_time and end_time.

string
<= 1024 characters

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
Known Bot Endpoint Response

Known Bot Endpoint Response.

object
known_bot_endpoints
Known Bot Endpoints

Known Bot Endpoints.

Array<object>
Known Bot Endpoints

Known Bot Endpoints.

object
absolute
Absolute

Configuration parameter for absolute

string format: uint64
<= 1024 characters
end_time
End time

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

string
<= 1024 characters
endpoint_label
Endpoint Label x-displayName: "Endpoint Label" x-example: "Login Page"

Endpoint or connection point

string
<= 1024 characters
endpoint_name
Endpoint Name x-displayName: "Endpoint Name" x-example: "/login"

Human-readable name for the resource

string
<= 1024 characters
endpoint_policy
Endpoint Policy x-displayName: "Endpoint Policy" x-example: "Protect"

Endpoint or connection point

string
<= 1024 characters
known_bot_category
Known Bot Category x-displayName: "Known Bot Category" x-example: "Search Engine Crawler"

Configuration parameter for known bot category

string
<= 1024 characters
known_bot_name
Known Bot Name x-displayName: "Known Bot Name" x-example: "Googlebot"

Human-readable name for the resource

string
<= 1024 characters
known_bot_provider
Known Bot Provider x-displayName: "Known Bot Provider" x-example: "Google LLC"

Configuration parameter for known bot provider

string
<= 1024 characters
known_bot_sentiment
Known Bot Sentiment

The sentiment for the trend of known bot traffic.

string
<= 1024 characters
percentage
Percentage

Tag for categorization and filtering

number format: double
start_time
Start time

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

string
<= 1024 characters
traffic_action_distribution
Traffic Action Distribution x-displayName: "Traffic Action Distribution" Traffic Action Distribution

Traffic Action Distribution.

Array<object>
Known Bot Generic Metric

Known Bot Generic Metric.

object
absolute
Absolute

Configuration parameter for absolute

string format: uint64
<= 1024 characters
name
Name

Human-readable name for the resource

string
>= 1 characters <= 63 characters /^[a-z]([-a-z0-9]*[a-z0-9])?$/
percentage
Percentage

Tag for categorization and filtering

number format: double
trend
Trend

Configuration parameter for trend

number format: double
pagination
object
page_number
Page Number

Configuration parameter for page number

integer format: int64
page_size
Page Size

Size or capacity specification

integer format: int64
total_rows
Total Rows

Configuration parameter for total rows

string format: uint64
<= 1024 characters
Examplegenerated
{
  "known_bot_endpoints": [
    {
      "absolute": "example",
      "end_time": "example",
      "endpoint_label": "example",
      "endpoint_name": "example",
      "endpoint_policy": "example",
      "known_bot_category": "example",
      "known_bot_name": "example",
      "known_bot_provider": "example",
      "known_bot_sentiment": "example",
      "percentage": 1,
      "start_time": "example",
      "traffic_action_distribution": [
        {
          "absolute": "example",
          "name": "example",
          "percentage": 1
        }
      ],
      "trend": 1
    }
  ],
  "pagination": {
    "page_number": 1,
    "page_size": 1,
    "total_rows": "example"
  }
}

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