Skip to main content
PUT
Share a report

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>.

Path Parameters

id
string
required

Body

application/json
access
enum<string>
required
Available options:
PRIVATE,
LINK,
PUBLIC
slug
string | null

Required the first time access is LINK or PUBLIC. Omitted, null or empty keeps the current slug. Trimmed and lowercased, then 3 to 40 lowercase letters, digits or single hyphens, starting and ending with a letter or digit; words the site uses for its own pages are reserved (400).

locale
enum<string>

Omit to keep the report's current language.

Available options:
en,
ko,
ja,
zh,
es,
fr,
de,
pt

Response

The sharing state after the change.

success
boolean
required
data
object
required