The SDK is currently in active development. For more details, see the U301 Postman docs.

Top bots detected in visits.

Use this API to retrieve recent most detected bots in a specified date range.

u301.analytics.getTopBots
import { U301 } from 'u301';

const apiKey = '<YOUR_API_KEY>';
const workspaceId = '<YOUR_WORKSPACE_ID>';

const u301 = new U301({
  apiKey,
  workspaceId,
});

const clicks = await u301.analytics.getTopBots({
    range: '1m',
    timezone: 'Europe/London'
})

the response schema

Request

NameLocationTypeRequiredDefaultDescription
AuthorizationHeaderstringBearer token used for authentication.
workspaceIdQuerystringWorkspace identifier for multi‑tenant routing.
rangeQuerystringDate range for data aggregation.
timezoneQuerystringUTCTimezone for data aggregation. See Timezone for details.

Response

Bot name was detected by it's user-agent string. Here are some examples: Googlebot, Bingbot, Baiduspider, YandexBot, DuckDuckBot, Applebot.

NameTypeDescription
datetimeRangestring[]Date range for data aggregation. The format is an array of two strings, each string is a timestamp in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ.
rangestringDate range for data aggregation.
data[].labelstringLabel for data aggregation.
data[].clicknumberClick count for data aggregation.
{
    "datetimeRange": [
        "2025-11-01T00:00:00.000Z",
        "2025-11-30T23:59:59.999Z"
    ],
    "range": "1m",
    "data": [
        {
            "label": "Googlebot",
            "click": 42
        },
        {
            "label": "Bingbot",
            "click": 17
        },
        {
            "label": "Baiduspider",
            "click": 9
        },
        {
            "label": "YandexBot",
            "click": 5
        },
        {
            "label": "DuckDuckBot",
            "click": 3
        },
        {
            "label": "Applebot",
            "click": 1
        }
    ]
}

Last updated on

On this page