Read crawlers report
Read crawlers from saved information using the same reporting services as the app. No new collection is started.
/projects/{projectId}/reports/crawlersdata:readThe key must include this project and its owner must still have access.
Report response structures vary by report type and available saved evidence. Dates default to the report’s recent reporting window.
Response examples use fictional saved information. Repeated array entries are shortened for readability; full responses contain all entries for the requested view or page. Null measurements mean unavailable, not zero.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Path parameters
projectIdstringRequiredProject identifier from List projects.
Query parameters
fromYYYY-MM-DDOptionalInclusive start date. Supply to with it; at most 366 days.
toYYYY-MM-DDOptionalInclusive end date. Supply from with it.
viewstringOptionaloverview, pages, bots or events.
Default:
overvieweventCursorstringOptionalSigned data.nextCursor from the events view. Keep every other parameter unchanged.
sourcestringOptionalFilter saved crawler activity by source.
platformstringOptionalFilter saved crawler activity by platform.
botstringOptionalFilter saved crawler activity by bot.
intentstringOptionalFilter saved crawler activity by intent.
statusstringOptionalFilter saved crawler activity by status.
pathstringOptionalFilter saved crawler activity by path.
searchstringOptionalSearch saved request paths, up to 500 characters.
pageintegerOptionalPage for pages/bots views, starting at 1.
Default:
1sortstringOptionalrequests, page or lastSeen.
Default:
requestsdirectionstringOptionalasc or desc.
Default:
desc
Response fields
dataobjectRequiredRead crawlers from saved information using the same reporting services as the app. No new collection is started.
Child fields
totalsobjectOptionalSaved totals for this report or view.
Child fields
requestsnumberOptionalSaved requests for this report or view.
pagesnumberOptionalSaved pages for this report or view.
botsnumberOptionalSaved bots for this report or view.
failednumberOptionalSaved failed for this report or view.
knownnumberOptionalSaved known for this report or view.
unknownnumberOptionalMentions without a usable sentiment classification.
previousvalue | nullOptionalSaved previous for this report or view.
trendarrayOptionalSaved trend for this report or view.
pagesarrayOptionalSaved pages for this report or view.
botsarrayOptionalSaved bots for this report or view.
coveragearrayOptionalSaved evidence coverage and its limitations.
truncatedbooleanOptionalSaved truncated for this report or view.
kindstringOptionalSaved kind for this report or view.
groupingstringOptionalSaved grouping for this report or view.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringOptionalSaved request id for this report or view.
resultScopestringOptionalSaved result scope for this report or view.