sharing

Embed

<a href="https://lucida.15-204-158-166.sslip.io/docs/ref-sharing"><img src="https://lucida.15-204-158-166.sslip.io/docs/_api/public/orgs/af34862a-c837-4478-8335-0505efe40459/spaces/da916cd3-c0fc-4b63-b971-b3c13623daf3/pages/764931cd-22d1-4880-9037-f05e758b00f5/social-card.svg?v=3e7ae33eec8b" alt="sharing" width="600" height="315"></a>

GEThttps://lucida.15-204-158-166.sslip.io/v1/embed/dashboards/{token}

Parameters

tokenstringpathrequired

refreshstringquery

1 recomputes (6 a minute per link)

grantstringquery

Code samples

cURL

curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/embed/dashboards/{token}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 iframe page; CSP frame-ancestors from the share's allowed origins

404

GEThttps://lucida.15-204-158-166.sslip.io/v1/embed/insights/{token}

Parameters

tokenstringpathrequired

refreshstringquery

1 recomputes (6 a minute per link)

grantstringquery

Code samples

cURL

curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/embed/insights/{token}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 iframe page; CSP frame-ancestors from the share's allowed origins

404

GEThttps://lucida.15-204-158-166.sslip.io/v1/embed/notebooks/{token}

Parameters

tokenstringpathrequired

grantstringquery

Code samples

cURL

curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/embed/notebooks/{token}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 iframe page; CSP frame-ancestors from the share's allowed origins

404

GEThttps://lucida.15-204-158-166.sslip.io/v1/embed/web/{token}

Parameters

tokenstringpathrequired

daysintegerquery

grantstringquery

Code samples

cURL

curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/embed/web/{token}"

TypeScript

Python

PHP

Ruby

Java

Responses

200 iframe widget; CSP frame-ancestors from the share's allowed origins

403

404

503

GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/branding

Parameters

project_idstringpathrequired

Code samples

cURL

curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/branding"

TypeScript

Python

PHP

Ruby

Java

Responses

200

Example

{
  "effective": {},
  "override": {}
}

Schema

effectiveobjectrequired

overrideobjectrequired

null fields inherit the org brand.

404

PUThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/branding

Parameters

project_idstringpathrequired

Request body

application/json

A project override; omitted or null fields inherit the org brand. All empty removes it.

accentstring

logo_urlstring

namestring

white_labelboolean

{
  "accent": "string",
  "logo_url": "string",
  "name": "string",
  "white_label": true
}

Code samples

cURL

curl -X PUT "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/branding" \
  -H "Content-Type: application/json" \
  -d '{"accent":"string","logo_url":"string","name":"string","white_label":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200

Same as 200 · GET /v1/projects/{project_id}/branding

400

403

404

GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/shares

Parameters

project_idstringpathrequired

idstringpathrequired

Code samples

cURL

curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/shares"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Array of Share, newest first

404

POSThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/shares

Parameters

project_idstringpathrequired

idstringpathrequired

Request body

application/json

allowed_originsstring[]

Embeds only: origins (https://app.example.com) allowed to frame the view; empty allows any.

expires_in_daysinteger

Lifetime in days (default 7, at most 90).

never_expiresboolean

No expiry at all; needs the org setting permanent_shares (403 otherwise).

optionsobject

Display options of the public view and embed.

Show child parameters

hide_brandingboolean

Leave out the Lucida branding.

hide_legendboolean

Leave out chart legends.

lock_filtersobject

Property group ({"and": [...]}, may hold a cohort filter) ANDed into every query the public view runs; viewers cannot remove it.

show_queriesboolean

Notebooks only: show the text of query blocks (hidden by default, queries can name people).

show_recordingsboolean

Notebooks only, project admins only (G146): replay and playlist blocks play in the shared view (masked at capture, no person ids, no comments). Withheld by default.

show_rowsboolean

Notebooks only, project admins only (G146): people, event, group and cohort lists share their rows (the block's chosen property columns; identities and email-like columns are always dropped) instead of per-day counts. Off by default.

themestring

light, dark or system (the default).

viewer_filtersboolean

Viewers may add their own event, person or session property filters (?filters=), applied on top of the lock.

passwordstring

Viewers must enter this password (8 to 200 characters); stored only as an argon2id hash.

{
  "allowed_origins": [
    "string"
  ],
  "expires_in_days": 0,
  "never_expires": true,
  "options": {
    "hide_branding": true,
    "hide_legend": true,
    "lock_filters": {},
    "show_queries": true,
    "show_recordings": true,
    "show_rows": true,
    "theme": "string",
    "viewer_filters": true
  },
  "password": "string"
}

Code samples

cURL

curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/shares" \
  -H "Content-Type: application/json" \
  -d '{"allowed_origins":["string"],"expires_in_days":0,"never_expires":true,"options":{"hide_branding":true,"hide_legend":true,"lock_filters":{},"show_queries":true,"show_recordings":true,"show_rows":true,"theme":"string","viewer_filters":true},"password":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201

Example

{
  "allowed_origins": [
    "string"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "expires_at": "2024-01-01T00:00:00Z",
  "id": "string",
  "options": {},
  "password_protected": true,
  "resource_id": "string",
  "resource_type": "string",
  "revoked_at": "2024-01-01T00:00:00Z",
  "token": "string"
}

Schema

allowed_originsstring[]required

Origins allowed to frame the embed (empty: any).

created_atstringrequired

expires_atstring

idstringrequired

optionsobjectrequired

{hide_branding?, hide_legend?, theme?: light|dark|system}.

password_protectedbooleanrequired

Viewers must enter a password first.

resource_idstringrequired

resource_typestringrequired

revoked_atstring

tokenstringrequired

Shown once; only its hash is stored.

400

403

404

DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/shares/{share_id}

Parameters

project_idstringpathrequired

idstringpathrequired

share_idstringpathrequired

Code samples

cURL

curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/dashboards/{id}/shares/{share_id}"

TypeScript

Python

PHP

Ruby

Java

Responses

204

403

404

GEThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/heatmaps/shares

Parameters

project_idstringpathrequired

urlstringqueryrequired

Code samples

cURL

curl -X GET "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/heatmaps/shares?url=<url>"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Array of Share for the page, newest first

400

404

POSThttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/heatmaps/shares

Parameters

project_idstringpathrequired

Request body

application/json

expires_in_daysinteger

Lifetime in days (default 7, at most 90).

urlstringrequired

Page path or URL whose heatmaps the link opens.

{
  "expires_in_days": 0,
  "url": "string"
}

Code samples

cURL

curl -X POST "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/heatmaps/shares" \
  -H "Content-Type: application/json" \
  -d '{"expires_in_days":0,"url":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 the token is shown once

Same as 201 · POST /v1/projects/{project_id}/dashboards/{id}/shares

400

403

404

DELETEhttps://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/heatmaps/shares/{share_id}

Parameters

project_idstringpathrequired

share_idstringpathrequired

Code samples

cURL

curl -X DELETE "https://lucida.15-204-158-166.sslip.io/v1/projects/{project_id}/heatmaps/shares/{share_id}"

TypeScript

Python

PHP

Ruby

Java

Responses

204

403

404

Next part

Updated Nov 3, 2026

Was this page helpful?