Analytics

Source-URL analytics

Returns per-URL aggregates: the percentage of analyzed responses in the window that cited each URL, together with the average number of citations to it per analyzed response. The response is paginated. This endpoint may not be scoped by segment.

GET /api/v1/analytics/source-urls

Query parameters

Name Type Required Description
start_date string Required

The inclusive UTC start of the analytics window, given as an ISO 8601 date (YYYY-MM-DD).
end_date string Required

The inclusive UTC end of the analytics window. The value must be on or after start_date, and on or before today.
models string[] Optional

You may use this parameter to limit responses to one or more AI engines. Repeat the parameter for each value, for example ?models[]=chatgpt&models[]=claude.
countries string[] Optional

You may use this parameter to limit responses to monitors run in the given ISO-3166-1 alpha-2 country codes.
monitors integer[] Optional

You may use this parameter to limit responses to specific monitors inside the active project.
tags integer[] Optional

You may use this parameter to limit responses to those whose prompt carries any of the given tag IDs, such as branded or non-branded.
page integer Optional

The page number to return. Defaults to 1.
per_page integer Optional

The number of items per page. Defaults to 25, maximum 100.
sort_by string Optional

The field to sort by. Defaults to used_percentage.
sort_order string Optional

The direction to sort by. Each endpoint has its own default.

Response

Response schema

Field Type Description
data SourceUrlAnalytics[]
links PaginationLinks
meta PaginationMeta

Per-URL analytics row

Field Type Description
source_url SourceUrl

The source URL this row covers.
used_count integer

The number of distinct analyzed responses in the window that cited this URL.
used_count_change integer

The difference in used_count compared with the equal-length period immediately preceding the window.
used_percentage integer

The percentage of analyzed responses in the window that cited this URL.
used_percentage_change integer

The difference in used_percentage compared with the equal-length period immediately preceding the window.
average_citations number

The average number of citations to this URL per analyzed response in the window.
average_citations_change number

The difference in average_citations compared with the preceding period.
first_seen_on string

The earliest date this URL was ever cited in the project. This is a lifetime value; the window, model, and country filters are ignored.
last_seen_on string

The most recent date this URL was cited in the project. This is a lifetime value; the window, model, and country filters are ignored.