Read shopping report
Read shopping from saved information using the same reporting services as the app. No new collection is started.
/projects/{projectId}/reports/shoppingdata: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 shopping from saved information using the same reporting services as the app. No new collection is started.
Child fields
capturesnumberOptionalSaved captures for this report or view.
completenumberOptionalSaved complete for this report or view.
partialnumberOptionalSaved partial for this report or view.
withCardsnumberOptionalSaved with cards for this report or view.
frequencyvalue | nullOptionalShopping frequency across complete reviewed captures; null when unavailable.
retailersarrayOptionalSaved retailers for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
answersnumberOptionalSaved answers for this report or view.
placementsnumberOptionalSaved placements for this report or view.
presencevalue | nullOptionalSaved presence for this report or view.
sharevalue | nullOptionalSaved share for this report or view.
brandsarrayOptionalSaved brands for this report or view.
placementsarrayOptionalSaved placements for this report or view.
promptRowsarrayOptionalSaved prompt rows for this report or view.
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.
notCapturednumberOptionalSaved not captured for this report or view.
mappingsarrayOptionalSaved mappings for this report or view.
findingsarrayOptionalSaved findings for this report or view.
trendarrayOptionalSaved trend for this report or view.
Child fields
datestringOptionalSaved date for this report or view.
capturesnumberOptionalSaved captures for this report or view.
completenumberOptionalSaved complete for this report or view.
partialnumberOptionalSaved partial for this report or view.
withCardsnumberOptionalSaved with cards for this report or view.
frequencyvalue | nullOptionalShopping frequency across complete reviewed captures; null when unavailable.
retailersarrayOptionalSaved retailers for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
namestringOptionalSaved name for this report or view.
domainstringOptionalSaved domain for this report or view.
answersnumberOptionalSaved answers for this report or view.
placementsnumberOptionalSaved placements for this report or view.
presencevalue | nullOptionalSaved presence for this report or view.
sharevalue | nullOptionalSaved share for this report or view.
brandsarrayOptionalSaved brands for this report or view.
placementsarrayOptionalSaved placements for this report or view.
promptsarrayOptionalSaved prompts for this report or view.
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.
requestIdstringOptionalSaved request id for this report or view.
resultScopestringOptionalSaved result scope for this report or view.