Skip to main content
GET
Export a client report

Authorizations

x-preuve-key
string
header
required

Your API key (prv_...), sent as-is. It is the only credential the API needs - see the Authentication guide.

Path Parameters

id
string<uuid>
required

Client report id, scoped to the caller's Agency workspace.

Query Parameters

verbosity
enum<string>
default:full

"full" is the whole payload. "summary" drops section prose and the Google Trends data points and keeps every scored field; what it left out is listed under the report's details.omitted.

Available options:
full,
summary

Response

The export payload.

schemaVersion
integer
exportType
enum<string>
Available options:
agency-report
dataAsOf
string<date-time>
exportedAt
string<date-time>
report
object

The report payload, same item shape as the ideas-json export. On verbosity=summary its details.omitted names what was dropped.

ownerExclusions
object[]

Competitor cards the workspace hid from the client view.

locked
object

Which fields this export left null, and why. Present only when the caller's tier withheld something, and absent entirely when the payload is complete. Read it before concluding a field is absent: a null under one of these paths is locked, not missing and not a failed analysis. It ships to every tier, paid included, and carries no price and no URL. On a batch export there is ONE object for the whole batch, the union of every exported item's withheld fields, deduplicated by path.