Read citations report
Read citations from saved information using the same reporting services as the app. No new collection is started.
/projects/{projectId}/reports/citationsdata: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.
marketstringOptionalFilter saved citations by market.
languagestringOptionalFilter saved citations by language.
platformstring · repeatedOptionalRepeat this parameter for each platform.
categorystringOptionalFilter saved citations by category.
runIdstringOptionalFilter saved citations by runId.
searchstringOptionalFilter saved citations by search.
domainstringOptionalFilter saved citations by domain.
promptTypestringOptionalall, branded or discovery.
Default:
allownershipstringOptionalall, own, competitor, other or unclassified.
Default:
allsignalstringOptionalall, rising, new or gaps.
Default:
allviewstringOptionalpages or domains.
Default:
pagessortstringOptionalcount, prompts, change, last or title.
Default:
countdirectionstringOptionalasc or desc.
Default:
descpageintegerOptionalPage, starting at 1.
Default:
1formatstringOptionaljson or csv.
Default:
json
Response fields
dataobjectRequiredRead citations from saved information using the same reporting services as the app. No new collection is started.
Child fields
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
comparisonUnavailablebooleanOptionalWhether a comparable earlier reporting period is unavailable.
scopeobjectOptionalResolved reporting period, filters and history boundaries.
Child fields
fromstringOptionalSaved from for this report or view.
tostringOptionalSaved to for this report or view.
marketstringOptionalSaved market for this report or view.
languagestringOptionalSaved language for this report or view.
platformsarrayOptionalSaved platforms for this report or view.
categorystringOptionalSaved category for this report or view.
promptTypestringOptionalSaved prompt type for this report or view.
runIdstringOptionalSaved run id for this report or view.
searchstringOptionalSaved search for this report or view.
ownershipstringOptionalSaved ownership for this report or view.
signalstringOptionalSaved signal for this report or view.
domainstringOptionalSaved domain for this report or view.
viewstringOptionalSaved view for this report or view.
sortstringOptionalSaved sort for this report or view.
directionstringOptionalSaved direction for this report or view.
pagenumberOptionalCurrent page, starting at 1.
formatstringOptionalSaved format for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
historyUnavailablebooleanOptionalSaved history unavailable for this report or view.
timezonestringOptionalSaved timezone for this report or view.
previousFromstringOptionalSaved previous from for this report or view.
previousTostringOptionalSaved previous to for this report or view.
summaryobjectOptionalSaved summary for this report or view.
Child fields
usablenumberOptionalNumber of usable saved answers in the resolved scope.
occurrencesnumberOptionalSaved occurrences for this report or view.
urlsnumberOptionalSaved urls for this report or view.
domainsnumberOptionalSaved domains for this report or view.
ownAnswersnumberOptionalSaved own answers for this report or view.
ownRatenumberOptionalSaved own rate for this report or view.
mixobjectOptionalSaved mix for this report or view.
Child fields
ownnumberOptionalSaved own for this report or view.
competitornumberOptionalSaved competitor for this report or view.
othernumberOptionalSaved other for this report or view.
unclassifiednumberOptionalSaved unclassified for this report or view.
activityarrayOptionalSaved activity for this report or view.
Child fields
datestringOptionalSaved date for this report or view.
samplesnumberOptionalSaved samples for this report or view.
openaivalue | nullOptionalSaved openai for this report or view.
claudevalue | nullOptionalSaved claude for this report or view.
perplexityvalue | nullOptionalSaved perplexity for this report or view.
google_overviewvalue | nullOptionalSaved google_overview for this report or view.
google_modevalue | nullOptionalSaved google_mode for this report or view.
geminivalue | nullOptionalSaved gemini for this report or view.
copilotvalue | nullOptionalSaved copilot for this report or view.
bing_modevalue | nullOptionalSaved bing_mode for this report or view.
comparisonobjectOptionalSaved comparison for this report or view.
Child fields
currentnumberOptionalSaved current for this report or view.
previousnumberOptionalSaved previous for this report or view.
cohortsnumberOptionalSaved cohorts for this report or view.
insightsobjectOptionalSaved insights for this report or view.
Child fields
risingnumberOptionalSaved rising for this report or view.
newnumberOptionalSaved new for this report or view.
gapsnumberOptionalSaved gaps for this report or view.
competitorEnabledbooleanOptionalSaved competitor enabled for this report or view.
hasPreviousbooleanOptionalSaved has previous for this report or view.
rowsarrayOptionalRows in this report’s current view.
totalnumberOptionalTotal matching entries before page slicing.
pagenumberOptionalCurrent page, starting at 1.
pageSizenumberOptionalRows per page.
runsarrayOptionalSaved runs for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
datestringOptionalSaved date for this report or view.
languagesarrayOptionalSaved languages for this report or view.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
scopeobjectOptionalResolved reporting period, filters and history boundaries.
Child fields
fromstringOptionalSaved from for this report or view.
tostringOptionalSaved to for this report or view.
marketstringOptionalSaved market for this report or view.
languagestringOptionalSaved language for this report or view.
platformsarrayOptionalSaved platforms for this report or view.
categorystringOptionalSaved category for this report or view.
promptTypestringOptionalSaved prompt type for this report or view.
runIdstringOptionalSaved run id for this report or view.
searchstringOptionalSaved search for this report or view.
ownershipstringOptionalSaved ownership for this report or view.
signalstringOptionalSaved signal for this report or view.
domainstringOptionalSaved domain for this report or view.
viewstringOptionalSaved view for this report or view.
sortstringOptionalSaved sort for this report or view.
directionstringOptionalSaved direction for this report or view.
pagenumberOptionalCurrent page, starting at 1.
formatstringOptionalSaved format for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
historyUnavailablebooleanOptionalSaved history unavailable for this report or view.
timezonestringOptionalSaved timezone for this report or view.
previousFromstringOptionalSaved previous from for this report or view.
previousTostringOptionalSaved previous to for this report or view.
requestIdstringOptionalSaved request id for this report or view.
resultScopestringOptionalSaved result scope for this report or view.