Read prompt results
Read the prompt’s result history, evidence and metrics.
/projects/{projectId}/prompts/{promptId}/resultsdata:readThe key must include this project and its owner must still have access.
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.
promptIdstringRequiredIdentifier from the corresponding resource list.
Query parameters
fromYYYY-MM-DDOptionalInclusive start date. Supply to with it; at most 366 days.
toYYYY-MM-DDOptionalInclusive end date. Supply from with it.
tabstringOptionaloverview, responses, citations or fanout.
Default:
overviewplatformstring · repeatedOptionalRepeat for each saved platform identifier.
modelstring · repeatedOptionalRepeat model identifiers to filter fan-out results.
fanoutKeystringOptionalSelect a fan-out group’s history.
occurrencePageintegerOptionalFan-out history page, starting at 1.
Default:
1pageintegerOptionalPage, starting at 1. Responses: 20 per page; citations/fan-out: 50.
Default:
1observationIdstringOptionalFilter by observationId. observationId selects one answer.
runIdstringOptionalFilter by runId. observationId selects one answer.
methodstringOptionalFilter by method. observationId selects one answer.
marketstringOptionalFilter by market. observationId selects one answer.
languagestringOptionalFilter by language. observationId selects one answer.
promptTypestringOptionalall, branded or discovery.
adsstring · repeatedOptionalyes, no or unknown.
shoppingstring · repeatedOptionalyes, no or unknown.
brandstring · repeatedOptionalyes, no or unknown.
citedstring · repeatedOptionalyes, no or unknown.
competitorstring · repeatedOptionalFilter competitor identifiers.
tonestring · repeatedOptionalpositive, negative, neutral or unknown.
sortstringOptionaldate_desc, date_asc, sentiment_asc or sentiment_desc.
Default:
date_descformatstringOptionaljson or csv.
Default:
json
Response fields
dataobjectRequiredRead the prompt’s result history, evidence and metrics.
Child fields
promptobjectOptionalSaved prompt for this report or view.
Child fields
idstringOptionalSaved id for this report or view.
textstringOptionalSaved text for this report or view.
marketstringOptionalSaved market for this report or view.
languagestringOptionalSaved language for this report or view.
scopeobjectOptionalResolved reporting period, filters and history boundaries.
Child fields
fromstringOptionalSaved from for this report or view.
tostringOptionalSaved to for this report or view.
platformsarrayOptionalSaved platforms for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
historyUnavailablebooleanOptionalSaved history unavailable for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
usablenumberOptionalNumber of usable saved answers in the resolved scope.
historicalPlatformsarrayOptionalSaved historical platforms for this report or view.
tabstringOptionalSaved tab for this report or view.
ownobjectOptionalSaved own 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.
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.
visibilitynumberOptionalSaved 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.
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
idstringOptionalSaved id for this report or view.
coveragevalue | nullOptionalSaved evidence coverage and its limitations.
totalCitationsnumberOptionalSaved total citations for this report or view.
competitorsarrayOptionalSaved competitors 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.
platformsarrayOptionalSaved platforms for this report or view.
reportingStartDatestringOptionalFirst day available in the account’s reporting history.
historyUnavailablebooleanOptionalSaved history unavailable for this report or view.
requestIdstringOptionalSaved request id for this report or view.
resultScopestringOptionalSaved result scope for this report or view.