GetDomainBotVisitDetails

Update time: 2023-02-03 10:30:45

Get the total number of domain requests, bot requests, bot relief attack requests, and Top5 bot type requests

  • Limit of request rate per user: 300/5min
  • Applicable Products: Bot Shield
For API authentication details, please refer to: API Authentication Overview

Request

Body Params

NameDescription
*domainString

Domain.Separate by';'.

*startTimeString

StartTime. Format: yyyy-MM-dd HH:mm:ss

*endTimeString

EndTime. Format: yyyy-MM-dd HH:mm:ss

timeZoneInteger

Time zone, default 8, i.e.'GTM+8'

langString

Language type. Default cn. en:English cn:Chinese

Response

Body Params

NameDescription
codeString

Status code, success is '200'.

messageString

Return message, success is 'Success'.

dataList

Data returned.

domainString

Domain.

totalRequestLong

Total request count.

botRequestLong

Bot request count.

reliefAttackLong

Relief attack count.

typeTotalLong

Total attack type count.

typeString

Top5 bot types.

Error code

Error code(code)Description(message)HTTP statusSemantic
22994001

CUSTOMER_NOT_EXIST

200customer not exist
22994000

PARAM_ERROR_CODE

200query param error
22995000

INTERNAL_ERROR_CODE

200internal error

Example

JSON
JSON
Request example
Copy Copy success
#!/bin/bash
username="example_username"
apiKey="example_apiKey" 
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url https://api.cdnetworks.com/api/bot/report/bot-visit-domain  \
-X "POST"  \
-u "$username:$password"  \
-H "Date: $date"   \
-H "Accept: application/json"  \
-H "Content-Type: application/json" \
-d '{ 
        "domain":"block3.baidu.com",
        "startTime":"2022-12-03 00:00:00",
        "endTime":"2023-12-03 23:59:59"
}'
Response example
Copy Copy success
{
    "code": 200,
    "message": "SUCCESS",
    "data": [
        {
            "reliefAttack": 103,
            "botRequest": 123,
            "domain": "example1.xxx.xxx",
            "type": [
                {
                    "num": 123,
                    "name": "example1",
                    "percent": 100.000
                }
            ],
            "typeTotal": 123,
            "totalRequest": 0
        },
        {
            "reliefAttack": 0,
            "botRequest": 0,
            "domain": "example2.xxx.xxx",
            "type": [],
            "typeTotal": 0,
            "totalRequest": 0
        },
        {
            "reliefAttack": 150,
            "botRequest": 164,
            "domain": "example3.xxx.xxx",
            "type": [
                {
                    "num": 108,
                    "name": "example1",
                    "percent": 65.900
                },
                {
                    "num": 31,
                    "name": "example2",
                    "percent": 18.900
                },
                {
                    "num": 21,
                    "name": "example3",
                    "percent": 12.800
                },
                {
                    "num": 4,
                    "name": "example4",
                    "percent": 2.400
                }
            ],
            "typeTotal": 164,
            "totalRequest": 0
        }
    ]
}
Is the content of this document helpful to you?
Yes
I have suggestion
Submitted successfully! Thank you very much for your feedback, we will continue to strive to do better!