Skip to main content
POST
Queue a report render

Authorizations

Authorization
string
header
required

An agent key (rpk_...) created in Settings → API & MCP, sent as Authorization: Bearer rpk_.... Bearer only: a cookie session can never drive this API. An OAuth 2.1 access token obtained from the same host works identically and lands on the same ceiling.

Headers

X-Workspace-Id
string

Which workspace to read. Omit it and you get the account’s home workspace, which on an agency account is often not where the live businesses are. A workspace this credential cannot read is refused with 403 rather than quietly answered from the default.

Body

application/json
template
string

Report template name.

business_location_id
string

Business the report covers.

period_start
string

ISO date the reporting period starts.

period_end
string

ISO date the reporting period ends.

include_ai_visibility
boolean

Include the AI Visibility section.

Response

Success.

The response is of type object.