Read action plan report
Read action plan from saved information using the same reporting services as the app. No new collection is started.
/projects/{projectId}/reports/action-plandata: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 action plan 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.
observedPlatformsarrayOptionalSaved observed platforms for this report or view.
coverageobjectOptionalSaved evidence coverage and its limitations.
Child fields
answersnumberOptionalSaved answers for this report or view.
promptsnumberOptionalSaved prompts for this report or view.
daysnumberOptionalSaved days for this report or view.
visibilitySummaryobjectOptionalSaved visibility summary for this report or view.
Child fields
answersnumberOptionalSaved answers for this report or view.
mentionsvalue | nullOptionalSaved mentions for this report or view.
citationsnumberOptionalSaved citations for this report or view.
visibilityvalue | nullOptionalSaved visibility for this report or view.
citationRatevalue | nullOptionalSaved citation rate for this report or view.
preparationobjectOptionalSaved preparation for this report or view.
Child fields
statestringOptionalSaved state for this report or view.
messagestringOptionalSaved message for this report or view.
actionsarrayOptionalSaved actions for this report or view.
reviewsarrayOptionalSaved reviews for this report or view.
workarrayOptionalSaved work 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.