Skip to content
ansvra.Documentation
Reports
Reports

Read overview report

Read overview from saved information using the same reporting services as the app. No new collection is started.

GET/projects/{projectId}/reports/overview
Required permission data:read

The 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 limits

Authorization

Authorizationstring · headerRequired

Bearer access key. Never put a key in the URL.

Path parameters

projectIdstringRequired

Project identifier from List projects.

Query parameters

startYYYY-MM-DDOptional

Inclusive reporting start date. Supply end with it.

endYYYY-MM-DDOptional

Inclusive reporting end date. At most 366 days.

daysintegerOptional

Relative reporting window when explicit dates are omitted: 7, 28 or 90.

Default: 28

marketstringOptional

Country code; defaults to the project market.

languagestringOptional

Language code; defaults to the project language.

platformsstringOptional

Comma-separated platform identifiers; empty includes available saved platforms.

promptIdsstringOptional

Comma-separated identifiers in this project; up to 200 values.

categoryIdsstringOptional

Comma-separated identifiers in this project; up to 200 values.

competitorIdsstringOptional

Comma-separated identifiers in this project; up to 200 values.

promptTypestringOptional

nonbranded, branded or all.

Default: nonbranded

methodstringOptional

Filter by the saved answer method.

Response fields

dataobjectRequired

Read overview from saved information using the same reporting services as the app. No new collection is started.

Child fields
scopeobjectOptional

Resolved reporting period, filters and history boundaries.

Child fields
projectIdstringOptional

Saved project id for this report or view.

reportingStartDatestringOptional

First day available in the account’s reporting history.

historyUnavailablebooleanOptional

Saved history unavailable for this report or view.

marketstringOptional

Saved market for this report or view.

languagestringOptional

Saved language for this report or view.

timezonestringOptional

Saved timezone for this report or view.

startstringOptional

Saved start for this report or view.

endstringOptional

Saved end for this report or view.

platformsarrayOptional

Saved platforms for this report or view.

promptIdsarrayOptional

Saved prompt ids for this report or view.

categoryIdsarrayOptional

Saved category ids for this report or view.

competitorIdsarrayOptional

Saved competitor ids for this report or view.

promptTypestringOptional

Saved prompt type for this report or view.

methodstringOptional

Saved method for this report or view.

daysnumberOptional

Saved days for this report or view.

reportingStartDatestringOptional

First day available in the account’s reporting history.

comparisonUnavailablebooleanOptional

Whether a comparable earlier reporting period is unavailable.

previousScopeobjectOptional

Saved previous scope for this report or view.

Child fields
projectIdstringOptional

Saved project id for this report or view.

reportingStartDatestringOptional

First day available in the account’s reporting history.

historyUnavailablebooleanOptional

Saved history unavailable for this report or view.

marketstringOptional

Saved market for this report or view.

languagestringOptional

Saved language for this report or view.

timezonestringOptional

Saved timezone for this report or view.

startstringOptional

Saved start for this report or view.

endstringOptional

Saved end for this report or view.

platformsarrayOptional

Saved platforms for this report or view.

promptIdsarrayOptional

Saved prompt ids for this report or view.

categoryIdsarrayOptional

Saved category ids for this report or view.

competitorIdsarrayOptional

Saved competitor ids for this report or view.

promptTypestringOptional

Saved prompt type for this report or view.

methodstringOptional

Saved method for this report or view.

daysnumberOptional

Saved days for this report or view.

brandsarrayOptional

Saved brands for this report or view.

Child fields
breakdownobjectOptional

Saved breakdown for this report or view.

Child fields
namestringOptional

Saved name for this report or view.

mentionednumberOptional

Saved mentioned for this report or view.

classifiednumberOptional

Saved classified for this report or view.

tonesobjectOptional

Saved tones for this report or view.

Child fields
positivenumberOptional

Saved positive for this report or view.

negativenumberOptional

Saved negative for this report or view.

neutralnumberOptional

Saved neutral for this report or view.

mixednumberOptional

Saved mixed for this report or view.

unknownnumberOptional

Mentions without a usable sentiment classification.

legacynumberOptional

Saved legacy for this report or view.

scorevalue | nullOptional

Saved score for this report or view.

groupsarrayOptional

Saved groups for this report or view.

idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainsarrayOptional

Saved domains for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

ownbooleanOptional

Saved own for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

mentionednumberOptional

Saved mentioned for this report or view.

citednumberOptional

Saved cited for this report or view.

visibilityvalue | nullOptional

Saved visibility for this report or view.

citationRatenumberOptional

Saved citation rate for this report or view.

citationCountnumberOptional

Saved citation count for this report or view.

mentionOrdervalue | nullOptional

Saved mention order for this report or view.

sentimentvalue | nullOptional

Saved sentiment for this report or view.

classifiednumberOptional

Saved classified for this report or view.

analysisCoveragevalue | nullOptional

Saved analysis coverage for this report or view.

tonesobjectOptional

Saved tones for this report or view.

Child fields
positivenumberOptional

Saved positive for this report or view.

negativenumberOptional

Saved negative for this report or view.

neutralnumberOptional

Saved neutral for this report or view.

mixednumberOptional

Saved mixed for this report or view.

shareOfVoicevalue | nullOptional

Saved share of voice for this report or view.

comparisonarrayOptional

Saved comparison for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

cohortsnumberOptional

Saved cohorts for this report or view.

previousvalue | nullOptional

Saved previous for this report or view.

currentvalue | nullOptional

Saved current for this report or view.

visibilityChangevalue | nullOptional

Saved visibility change for this report or view.

citationChangevalue | nullOptional

Saved citation change for this report or view.

previousSamplenumberOptional

Saved previous sample for this report or view.

currentSamplenumberOptional

Saved current sample for this report or view.

evidencearrayOptional

Saved evidence for this report or view.

trendarrayOptional

Saved trend for this report or view.

Child fields
datestringOptional

Saved date for this report or view.

rowsarrayOptional

Rows in this report’s current view.

Child fields
breakdownobjectOptional

Saved breakdown for this report or view.

Child fields
namestringOptional

Saved name for this report or view.

mentionednumberOptional

Saved mentioned for this report or view.

classifiednumberOptional

Saved classified for this report or view.

tonesobjectOptional

Saved tones for this report or view.

unknownnumberOptional

Mentions without a usable sentiment classification.

legacynumberOptional

Saved legacy for this report or view.

scorevalue | nullOptional

Saved score for this report or view.

groupsarrayOptional

Saved groups for this report or view.

idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainsarrayOptional

Saved domains for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

ownbooleanOptional

Saved own for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

mentionednumberOptional

Saved mentioned for this report or view.

citednumberOptional

Saved cited for this report or view.

visibilityvalue | nullOptional

Saved visibility for this report or view.

citationRatevalue | nullOptional

Saved citation rate for this report or view.

citationCountnumberOptional

Saved citation count for this report or view.

mentionOrdervalue | nullOptional

Saved mention order for this report or view.

sentimentvalue | nullOptional

Saved sentiment for this report or view.

classifiednumberOptional

Saved classified for this report or view.

analysisCoveragevalue | nullOptional

Saved analysis coverage for this report or view.

tonesobjectOptional

Saved tones for this report or view.

Child fields
positivenumberOptional

Saved positive for this report or view.

negativenumberOptional

Saved negative for this report or view.

neutralnumberOptional

Saved neutral for this report or view.

mixednumberOptional

Saved mixed for this report or view.

shareOfVoicevalue | nullOptional

Saved share of voice for this report or view.

heatmaparrayOptional

Saved heatmap for this report or view.

Child fields
categoryIdstringOptional

Saved category id for this report or view.

categorystringOptional

Saved category for this report or view.

platformstringOptional

Saved platform for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

rowsarrayOptional

Rows in this report’s current view.

Child fields
breakdownobjectOptional

Saved breakdown for this report or view.

Child fields
namestringOptional

Saved name for this report or view.

mentionednumberOptional

Saved mentioned for this report or view.

classifiednumberOptional

Saved classified for this report or view.

tonesobjectOptional

Saved tones for this report or view.

unknownnumberOptional

Mentions without a usable sentiment classification.

legacynumberOptional

Saved legacy for this report or view.

scorevalue | nullOptional

Saved score for this report or view.

groupsarrayOptional

Saved groups for this report or view.

idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

domainsarrayOptional

Saved domains for this report or view.

brandAliasesarrayOptional

Saved brand aliases for this report or view.

ownbooleanOptional

Saved own for this report or view.

includeSubdomainsbooleanOptional

Saved include subdomains for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

mentionednumberOptional

Saved mentioned for this report or view.

citednumberOptional

Saved cited for this report or view.

visibilityvalue | nullOptional

Saved visibility for this report or view.

citationRatenumberOptional

Saved citation rate for this report or view.

citationCountnumberOptional

Saved citation count for this report or view.

mentionOrdervalue | nullOptional

Saved mention order for this report or view.

sentimentvalue | nullOptional

Saved sentiment for this report or view.

classifiednumberOptional

Saved classified for this report or view.

analysisCoveragevalue | nullOptional

Saved analysis coverage for this report or view.

tonesobjectOptional

Saved tones for this report or view.

Child fields
positivenumberOptional

Saved positive for this report or view.

negativenumberOptional

Saved negative for this report or view.

neutralnumberOptional

Saved neutral for this report or view.

mixednumberOptional

Saved mixed for this report or view.

pairwisearrayOptional

Saved pairwise for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

configuredbooleanOptional

Saved configured for this report or view.

ownOnlynumberOptional

Saved own only for this report or view.

competitorOnlynumberOptional

Saved competitor only for this report or view.

bothnumberOptional

Saved both for this report or view.

neithernumberOptional

Saved neither for this report or view.

sourcesarrayOptional

Saved sources or source audit information.

findingsarrayOptional

Saved findings for this report or view.

conflictsarrayOptional

Saved conflicts for this report or view.

usablenumberOptional

Number of usable saved answers in the resolved scope.

diagnosticsnumberOptional

Saved diagnostics for this report or view.

promptCountnumberOptional

Saved prompt count for this report or view.

lateststringOptional

Latest saved result timestamp, or null.

metaobjectRequired

Request metadata. Present on JSON success responses.

Child fields
scopeobjectOptional

Resolved reporting period, filters and history boundaries.

Child fields
projectIdstringOptional

Saved project id for this report or view.

reportingStartDatestringOptional

First day available in the account’s reporting history.

historyUnavailablebooleanOptional

Saved history unavailable for this report or view.

marketstringOptional

Saved market for this report or view.

languagestringOptional

Saved language for this report or view.

timezonestringOptional

Saved timezone for this report or view.

startstringOptional

Saved start for this report or view.

endstringOptional

Saved end for this report or view.

platformsarrayOptional

Saved platforms for this report or view.

promptIdsarrayOptional

Saved prompt ids for this report or view.

categoryIdsarrayOptional

Saved category ids for this report or view.

competitorIdsarrayOptional

Saved competitor ids for this report or view.

promptTypestringOptional

Saved prompt type for this report or view.

methodstringOptional

Saved method for this report or view.

daysnumberOptional

Saved days for this report or view.

lateststringOptional

Latest saved result timestamp, or null.

resultScopestringOptional

Saved result scope for this report or view.

requestIdstringOptional

Saved request id for this report or view.

Ansvra

A clearer next step.

MEET YOUR AI GUIDE

A little clarity.
A clearer next move.

Ask about Ansvra, AI visibility, or your next step with content.

Opening chat…