Skip to main content
POST
Create a share link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Any unique string up to 255 characters, such as a UUID. A retry with the same key and body within 24 hours answers what the first call did, without writing again.

Required string length: 1 - 255

Path Parameters

site
string
required

The site: its domain as registered (example.com), or its site id.

Body

application/json
name
string
required

The link's name, for the site's own list.

Required string length: 1 - 100
password
string

A password the viewer types before the board opens, 6 to 200 characters. Never returned.

Required string length: 6 - 200
expiresAt
string<date>

The last day the link opens, YYYY-MM-DD in the site's timezone.

filters
string[]

Filters the viewer cannot remove, each written as a report's filter parameter, dimension[.key]:operator:value, such as page_path:contains:/blog.

Maximum array length: 20
showNotes
boolean
default:false

Whether the link shows the chart's notes.

showRevenue
boolean
default:false

Whether the link shows revenue.

hideBranding
boolean
default:false

Whether the board hides the product's branding.

Response

OK

data
object
required