Skip to main content
POST
Generate a shareable report

Authorizations

Authorization
string
header
required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Headers

Idempotency-Key
string

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.

Path Parameters

projectId
string<uuid>
required

The project id.

Body

application/json
reportType
enum<string>
default:sentiment
Available options:
sentiment,
visibility,
combined
timeRange
enum<string>
default:30d
Available options:
7d,
30d,
90d,
365d
platforms
string[]
topicIds
string<uuid>[]
locationIds
string[]
unbrandedOnly
boolean
default:false
brandedOnly
boolean
default:false
whiteLabel
boolean
default:false

Requires a white-label-entitled plan.

title
string
Required string length: 1 - 200
status
enum<string>
default:published
Available options:
published,
draft

Response

Report generated.

shareToken
string
required
shareUrl
string<uri>
required
reportType
enum<string>
required
Available options:
sentiment,
visibility,
combined
success
boolean
required
whiteLabel
boolean