Skip to content
ansvra.Documentation
Reports
Reports

Read shopping report

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

GET/projects/{projectId}/reports/shopping
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 shopping from saved information using the same reporting services as the app. No new collection is started.

Child fields
capturesnumberOptional

Saved captures for this report or view.

completenumberOptional

Saved complete for this report or view.

partialnumberOptional

Saved partial for this report or view.

withCardsnumberOptional

Saved with cards for this report or view.

frequencyvalue | nullOptional

Shopping frequency across complete reviewed captures; null when unavailable.

retailersarrayOptional

Saved retailers for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

answersnumberOptional

Saved answers for this report or view.

placementsnumberOptional

Saved placements for this report or view.

presencevalue | nullOptional

Saved presence for this report or view.

sharevalue | nullOptional

Saved share for this report or view.

brandsarrayOptional

Saved brands for this report or view.

placementsarrayOptional

Saved placements for this report or view.

promptRowsarrayOptional

Saved prompt rows for this report or view.

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.

notCapturednumberOptional

Saved not captured for this report or view.

mappingsarrayOptional

Saved mappings for this report or view.

findingsarrayOptional

Saved findings for this report or view.

trendarrayOptional

Saved trend for this report or view.

Child fields
datestringOptional

Saved date for this report or view.

capturesnumberOptional

Saved captures for this report or view.

completenumberOptional

Saved complete for this report or view.

partialnumberOptional

Saved partial for this report or view.

withCardsnumberOptional

Saved with cards for this report or view.

frequencyvalue | nullOptional

Shopping frequency across complete reviewed captures; null when unavailable.

retailersarrayOptional

Saved retailers for this report or view.

Child fields
idstringOptional

Saved id for this report or view.

namestringOptional

Saved name for this report or view.

domainstringOptional

Saved domain for this report or view.

answersnumberOptional

Saved answers for this report or view.

placementsnumberOptional

Saved placements for this report or view.

presencevalue | nullOptional

Saved presence for this report or view.

sharevalue | nullOptional

Saved share for this report or view.

brandsarrayOptional

Saved brands for this report or view.

placementsarrayOptional

Saved placements for this report or view.

promptsarrayOptional

Saved prompts for this report or view.

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.

requestIdstringOptional

Saved request id for this report or view.

resultScopestringOptional

Saved result scope 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…