Skip to content

Insight Event: Total Automation.

POST
/api/shape/bot/namespaces/{namespace}/reporting/insight/total-automation
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/reporting/insight/total-automation \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "date": "example", "namespace": "example", "region": "example" }'

GET Insight Totol Automation data.

Examples of this operation.

namespace
required
string

Namespace

x-required Namespace.

Media typeapplication/json
Insight Request

Insight Request.

object
date
Date

Date Format: YYYY/MM/DD Required: YES.

string
<= 1024 characters
namespace
Namespace

Namespace Required: YES.

string
>= 6 characters <= 1024 characters
region
Region

Region Required: YES.

string
<= 1024 characters
Examplegenerated
{
"date": "example",
"namespace": "example",
"region": "example"
}

A successful response.

Media typeapplication/json
InsightEvent: TotalAutomationResponse

Response for Total Automation Insight Event.

object
automated
Automated

Number of HTTP requests identified as automated traffic.

string format: uint64
<= 1024 characters
automated_percentage
automated Percentage

The percentage of the number of automated traffic / the total number.

number format: double
create_date
Create_Date

UTC Create Date in seconds.

number format: double
endpoint
Endpoint

The number of Endpoint.

string format: uint64
<= 1024 characters
endpoint_label

Endpoint or connection point

string
<= 1024 characters
good_bot
Good Bot

Number of HTTP requests identified as good bot traffic within specified time interval.

string format: uint64
<= 1024 characters
good_bot_percentage
Good Bot Percentage

The percentage of the number of good bot traffic / the total number.

number format: double
human
Human

Number of HTTP requests identified as human traffic.

string format: uint64
<= 1024 characters
human_percentage
Human Percentage

The percentage of the number of human traffic / the total number.

number format: double
malicious_bot
Malicious Bot

Number of HTTP requests identified as malicious bot traffic.

string format: uint64
<= 1024 characters
malicious_bot_percentage
Malicious Bot Percentage

The percentage of the number of malicious bot traffic / the total number.

number format: double
mobile
Mobile

Number of HTTP requests identified as traffic channel is mobile.

string format: uint64
<= 1024 characters
mobile_percentage
Mobile Percentage

The percentage of the number of traffic channel:mobile / the total number.

number format: double
others
Others

Number of HTTP requests identified as other traffic within specified time interval.

string format: uint64
<= 1024 characters
others_percentage
Others Percentage

The percentage of the number of others traffic / the total number.

number format: double
traffic_channel
Traffic Channel

The majority of automated traffic channel.

string
<= 1024 characters
web
Web

Number of HTTP requests identified as traffic channel is web.

string format: uint64
<= 1024 characters
web_percentage
Web Percentage

The percentage of the number of traffic channel:web / the total number.

number format: double
Examplegenerated
{
"automated": "example",
"automated_percentage": 1,
"create_date": 1,
"endpoint": "example",
"endpoint_label": "example",
"good_bot": "example",
"good_bot_percentage": 1,
"human": "example",
"human_percentage": 1,
"malicious_bot": "example",
"malicious_bot_percentage": 1,
"mobile": "example",
"mobile_percentage": 1,
"others": "example",
"others_percentage": 1,
"traffic_channel": "example",
"web": "example",
"web_percentage": 1
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

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

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example