Sign in
Shared Dashboards

Create a shared dashboard link

Mint a password-protected, publicly-reachable dashboard link for the shop — the thing a brand sends an agency or an investor. The response carries the uuid and the share_url to hand out; the password is never echoed back, so store what you sent.

One live link per shop: creating a second while one is active returns 409. Archive the old one first with DELETE, which mints a fresh uuid and password on the next create rather than resurrecting the old link.

Optionally lock the link to a fixed reporting window (locked_start_date + locked_end_date, both or neither) and choose what it shows via report_config. Outreach-volume metrics — TC invites, DMs sent, creators reached, sample counts — cannot be put on a share link and are rejected.

Requires read_write scope and an Idempotency-Key header. Single-shop only.

post/shared-dashboards

Headers

Idempotency-Keystring nullable

Request body

passwordstring required

Password the viewer must enter. At least 8 characters with an uppercase letter, a lowercase letter and a digit — or 12+ characters as a passphrase.

locked_start_datestring date nullable

Start of a fixed reporting window (with locked_end_date).

locked_end_datestring date nullable

End of a fixed reporting window (with locked_start_date).

Response

Successful Response

uuidstring required
share_urlstring required
statusstring required
created_atstring required
locked_start_datestring date nullable
locked_end_datestring date nullable
shop_idinteger required

Shop this share link reports on.

Changes

No recorded changes to this endpoint across all 1 revision of this API.