Read overview report
Read overview from saved information using the same reporting services as the app. No new collection is started.
/projects/{projectId}/reports/overviewdata: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
startYYYY-MM-DDOptionalInclusive reporting start date. Supply end with it.
endYYYY-MM-DDOptionalInclusive reporting end date. At most 366 days.
daysintegerOptionalRelative reporting window when explicit dates are omitted: 7, 28 or 90.
Default:
28marketstringOptionalCountry code; defaults to the project market.
languagestringOptionalLanguage code; defaults to the project language.
platformsstringOptionalComma-separated platform identifiers; empty includes available saved platforms.
promptIdsstringOptionalComma-separated identifiers in this project; up to 200 values.
categoryIdsstringOptionalComma-separated identifiers in this project; up to 200 values.
competitorIdsstringOptionalComma-separated identifiers in this project; up to 200 values.
promptTypestringOptionalnonbranded, branded or all.
Default:
nonbrandedmethodstringOptionalFilter by the saved answer method.
Response fields
dataobjectRequiredRead overview from saved information using the same reporting services as the app. No new collection is started.
Child fields
scopeobjectOptionalResolved reporting period, filters and history boundaries.
Child fields
projectIdstringOptionalSaved project id for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
historyUnavailablebooleanOptionalSaved history unavailable for this report or view.
marketstringOptionalSaved market for this report or view.
languagestringOptionalSaved language for this report or view.
timezonestringOptionalSaved timezone for this report or view.
startstringOptionalSaved start for this report or view.
endstringOptionalSaved end for this report or view.
platformsarrayOptionalSaved platforms for this report or view.
promptIdsarrayOptionalSaved prompt ids for this report or view.
categoryIdsarrayOptionalSaved category ids for this report or view.
competitorIdsarrayOptionalSaved competitor ids for this report or view.
promptTypestringOptionalSaved prompt type for this report or view.
methodstringOptionalSaved method for this report or view.
daysnumberOptionalSaved days for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
comparisonUnavailablebooleanOptionalWhether a comparable earlier reporting period is unavailable.
previousScopeobjectOptionalSaved previous scope for this report or view.
Child fields
projectIdstringOptionalSaved project id for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
historyUnavailablebooleanOptionalSaved history unavailable for this report or view.
marketstringOptionalSaved market for this report or view.
languagestringOptionalSaved language for this report or view.
timezonestringOptionalSaved timezone for this report or view.
startstringOptionalSaved start for this report or view.
endstringOptionalSaved end for this report or view.
platformsarrayOptionalSaved platforms for this report or view.
promptIdsarrayOptionalSaved prompt ids for this report or view.
categoryIdsarrayOptionalSaved category ids for this report or view.
competitorIdsarrayOptionalSaved competitor ids for this report or view.
promptTypestringOptionalSaved prompt type for this report or view.
methodstringOptionalSaved method for this report or view.
daysnumberOptionalSaved days for this report or view.
brandsarrayOptionalSaved brands for this report or view.
Child fields
breakdownobjectOptionalSaved breakdown for this report or view.
Child fields
namestringOptionalSaved name for this report or view.
mentionednumberOptionalSaved mentioned for this report or view.
classifiednumberOptionalSaved classified for this report or view.
tonesobjectOptionalSaved tones for this report or view.
Child fields
positivenumberOptionalSaved positive for this report or view.
negativenumberOptionalSaved negative for this report or view.
neutralnumberOptionalSaved neutral for this report or view.
mixednumberOptionalSaved mixed for this report or view.
unknownnumberOptionalMentions without a usable sentiment classification.
legacynumberOptionalSaved legacy for this report or view.
scorevalue | nullOptionalSaved score for this report or view.
groupsarrayOptionalSaved groups for this report or view.
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainsarrayOptionalSaved domains for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
ownbooleanOptionalSaved own for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
mentionednumberOptionalSaved mentioned for this report or view.
citednumberOptionalSaved cited for this report or view.
visibilityvalue | nullOptionalSaved visibility for this report or view.
citationRatenumberOptionalSaved citation rate for this report or view.
citationCountnumberOptionalSaved citation count for this report or view.
mentionOrdervalue | nullOptionalSaved mention order for this report or view.
sentimentvalue | nullOptionalSaved sentiment for this report or view.
classifiednumberOptionalSaved classified for this report or view.
analysisCoveragevalue | nullOptionalSaved analysis coverage for this report or view.
tonesobjectOptionalSaved tones for this report or view.
Child fields
positivenumberOptionalSaved positive for this report or view.
negativenumberOptionalSaved negative for this report or view.
neutralnumberOptionalSaved neutral for this report or view.
mixednumberOptionalSaved mixed for this report or view.
shareOfVoicevalue | nullOptionalSaved share of voice for this report or view.
comparisonarrayOptionalSaved comparison for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
cohortsnumberOptionalSaved cohorts for this report or view.
previousvalue | nullOptionalSaved previous for this report or view.
currentvalue | nullOptionalSaved current for this report or view.
visibilityChangevalue | nullOptionalSaved visibility change for this report or view.
citationChangevalue | nullOptionalSaved citation change for this report or view.
previousSamplenumberOptionalSaved previous sample for this report or view.
currentSamplenumberOptionalSaved current sample for this report or view.
evidencearrayOptionalSaved evidence for this report or view.
trendarrayOptionalSaved trend for this report or view.
Child fields
datestringOptionalSaved date for this report or view.
rowsarrayOptionalRows in this report’s current view.
Child fields
breakdownobjectOptionalSaved breakdown for this report or view.
Child fields
namestringOptionalSaved name for this report or view.
mentionednumberOptionalSaved mentioned for this report or view.
classifiednumberOptionalSaved classified for this report or view.
tonesobjectOptionalSaved tones for this report or view.
unknownnumberOptionalMentions without a usable sentiment classification.
legacynumberOptionalSaved legacy for this report or view.
scorevalue | nullOptionalSaved score for this report or view.
groupsarrayOptionalSaved groups for this report or view.
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainsarrayOptionalSaved domains for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
ownbooleanOptionalSaved own for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
mentionednumberOptionalSaved mentioned for this report or view.
citednumberOptionalSaved cited for this report or view.
visibilityvalue | nullOptionalSaved visibility for this report or view.
citationRatevalue | nullOptionalSaved citation rate for this report or view.
citationCountnumberOptionalSaved citation count for this report or view.
mentionOrdervalue | nullOptionalSaved mention order for this report or view.
sentimentvalue | nullOptionalSaved sentiment for this report or view.
classifiednumberOptionalSaved classified for this report or view.
analysisCoveragevalue | nullOptionalSaved analysis coverage for this report or view.
tonesobjectOptionalSaved tones for this report or view.
Child fields
positivenumberOptionalSaved positive for this report or view.
negativenumberOptionalSaved negative for this report or view.
neutralnumberOptionalSaved neutral for this report or view.
mixednumberOptionalSaved mixed for this report or view.
shareOfVoicevalue | nullOptionalSaved share of voice for this report or view.
heatmaparrayOptionalSaved heatmap for this report or view.
Child fields
categoryIdstringOptionalSaved category id for this report or view.
categorystringOptionalSaved category for this report or view.
platformstringOptionalSaved platform for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
rowsarrayOptionalRows in this report’s current view.
Child fields
breakdownobjectOptionalSaved breakdown for this report or view.
Child fields
namestringOptionalSaved name for this report or view.
mentionednumberOptionalSaved mentioned for this report or view.
classifiednumberOptionalSaved classified for this report or view.
tonesobjectOptionalSaved tones for this report or view.
unknownnumberOptionalMentions without a usable sentiment classification.
legacynumberOptionalSaved legacy for this report or view.
scorevalue | nullOptionalSaved score for this report or view.
groupsarrayOptionalSaved groups for this report or view.
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
domainsarrayOptionalSaved domains for this report or view.
brandAliasesarrayOptionalSaved brand aliases for this report or view.
ownbooleanOptionalSaved own for this report or view.
includeSubdomainsbooleanOptionalSaved include subdomains for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
mentionednumberOptionalSaved mentioned for this report or view.
citednumberOptionalSaved cited for this report or view.
visibilityvalue | nullOptionalSaved visibility for this report or view.
citationRatenumberOptionalSaved citation rate for this report or view.
citationCountnumberOptionalSaved citation count for this report or view.
mentionOrdervalue | nullOptionalSaved mention order for this report or view.
sentimentvalue | nullOptionalSaved sentiment for this report or view.
classifiednumberOptionalSaved classified for this report or view.
analysisCoveragevalue | nullOptionalSaved analysis coverage for this report or view.
tonesobjectOptionalSaved tones for this report or view.
Child fields
positivenumberOptionalSaved positive for this report or view.
negativenumberOptionalSaved negative for this report or view.
neutralnumberOptionalSaved neutral for this report or view.
mixednumberOptionalSaved mixed for this report or view.
pairwisearrayOptionalSaved pairwise for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
configuredbooleanOptionalSaved configured for this report or view.
ownOnlynumberOptionalSaved own only for this report or view.
competitorOnlynumberOptionalSaved competitor only for this report or view.
bothnumberOptionalSaved both for this report or view.
neithernumberOptionalSaved neither for this report or view.
sourcesarrayOptionalSaved sources or source audit information.
findingsarrayOptionalSaved findings for this report or view.
conflictsarrayOptionalSaved conflicts for this report or view.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
diagnosticsnumberOptionalSaved diagnostics for this report or view.
promptCountnumberOptionalSaved prompt count for this report or view.
lateststringOptionalLatest saved result timestamp, or null.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
scopeobjectOptionalResolved reporting period, filters and history boundaries.
Child fields
projectIdstringOptionalSaved project id for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
historyUnavailablebooleanOptionalSaved history unavailable for this report or view.
marketstringOptionalSaved market for this report or view.
languagestringOptionalSaved language for this report or view.
timezonestringOptionalSaved timezone for this report or view.
startstringOptionalSaved start for this report or view.
endstringOptionalSaved end for this report or view.
platformsarrayOptionalSaved platforms for this report or view.
promptIdsarrayOptionalSaved prompt ids for this report or view.
categoryIdsarrayOptionalSaved category ids for this report or view.
competitorIdsarrayOptionalSaved competitor ids for this report or view.
promptTypestringOptionalSaved prompt type for this report or view.
methodstringOptionalSaved method for this report or view.
daysnumberOptionalSaved days for this report or view.
lateststringOptionalLatest saved result timestamp, or null.
resultScopestringOptionalSaved result scope for this report or view.
requestIdstringOptionalSaved request id for this report or view.