Skip to content
ansvra.Documentation
Reports
Reports

Read action plan report

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

GET/projects/{projectId}/reports/action-plan
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 action plan 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.

observedPlatformsarrayOptional

Saved observed platforms for this report or view.

coverageobjectOptional

Saved evidence coverage and its limitations.

Child fields
answersnumberOptional

Saved answers for this report or view.

promptsnumberOptional

Saved prompts for this report or view.

daysnumberOptional

Saved days for this report or view.

visibilitySummaryobjectOptional

Saved visibility summary for this report or view.

Child fields
answersnumberOptional

Saved answers for this report or view.

mentionsvalue | nullOptional

Saved mentions for this report or view.

citationsnumberOptional

Saved citations for this report or view.

visibilityvalue | nullOptional

Saved visibility for this report or view.

citationRatevalue | nullOptional

Saved citation rate for this report or view.

preparationobjectOptional

Saved preparation for this report or view.

Child fields
statestringOptional

Saved state for this report or view.

messagestringOptional

Saved message for this report or view.

actionsarrayOptional

Saved actions for this report or view.

reviewsarrayOptional

Saved reviews for this report or view.

workarrayOptional

Saved work 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…