v1

latestOpenAPI 3.1.02026-07-265897154.5 KB

Reports

Generate a shareable report

Generate and publish a shareable report; returns { shareToken, shareUrl }. Set whiteLabel=true (requires a white-label-entitled plan) to apply workspace branding. Requires the write scope. Supports Idempotency-Key replay.

post/api/mcp/projects/{projectId}/reports

Path parameters

projectIdstring uuid required

The project id.

Headers

Idempotency-Keystring

Optional client-generated key (e.g. a UUID). Retrying with the same key within 24h replays the original stored response (X-Idempotent-Replay: true) instead of repeating the side effect. See Idempotency.

Request body

reportType'sentiment' | 'visibility' | 'combined'

timeRange'7d' | '30d' | '90d' | '365d'

platformsstring[]

topicIdsstring[]

locationIdsstring[]

unbrandedOnlyboolean

brandedOnlyboolean

whiteLabelboolean

Requires a white-label-entitled plan.

titlestring

status'published' | 'draft'

Response

Report generated.

shareTokenstring required

shareUrlstring uri required

reportType'sentiment' | 'visibility' | 'combined' required

whiteLabelboolean

successboolean required