v1

latestOpenAPI 3.1.02026-07-263370112.1 KB
agent-traffic

Get Agent Traffic

Retrieve aggregated bot and AI agent traffic data for a specific site.

This endpoint provides visibility into how AI agents and bots are accessing your web properties. Use it to analyze traffic patterns, identify top agents, and understand crawl behavior over time.

Available Dimensions

The following dimensions can be included in the fields parameter to group results:

FieldDescription
dateDaily timestamp for the traffic record
siteThe site domain being analyzed
pathURL path on the site
agent_sourceThe source/origin of the agent (e.g., OpenAI, Google, Anthropic)
agent_typeClassification of the agent type

Metrics

Traffic counts are automatically included in the response based on the selected dimensions.

get/{brand_id}/sites/{site_id}/agent-traffic

Path parameters

brand_idinteger required
string required
OR
string binary required

The unique identifier of the site to retrieve agent traffic for.

Query parameters

start_datestring date required

Start date for the query range (inclusive). Format: YYYY-MM-DD.

Start date for the query range (inclusive). Format: YYYY-MM-DD.

end_datestring date required

End date for the query range (inclusive). Format: YYYY-MM-DD.

End date for the query range (inclusive). Format: YYYY-MM-DD.

fieldsstring nullable

Comma-separated list of dimensions to include in the response. Available dimensions: date, site, path, agent_source, agent_type. If not specified, returns aggregated totals.

Comma-separated list of dimensions to include in the response. Available dimensions: date, site, path, agent_source, agent_type. If not specified, returns aggregated totals.

time_bucket'day' | 'week'

Time aggregation bucket for grouping results. Options: day, week, month. Defaults to day.

Time aggregation bucket for grouping results. Options: day, week, month. Defaults to day.

pathstring nullable

Filter results to a specific URL path or path prefix.

Filter results to a specific URL path or path prefix.

limitinteger

Maximum number of rows to return. Use with offset for pagination.

Maximum number of rows to return. Use with offset for pagination.

offsetinteger

Number of rows to skip before returning results. Use with limit for pagination.

Number of rows to skip before returning results. Use with limit for pagination.

Response

Successful Response

All 33 operations