Create shared link
Create a shared link to the dashboard under Visibility in the site settings.
POST https://cotlet.dev/api/v1/plausible/shared-links
write Confirm
Returns the new link. Anyone with the link sees the dashboard without a Plausible account, and only that site. With a segment, viewers can add filters but cannot remove the segment. Shared-link viewers do not count toward your team member limit. The link goes to other people. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| site string required | string | Domain of the site as the Sites page lists it, e.g. acme-shop.example. |
| name string required | string | Label for your own reference. Viewers do not see it. |
| password string | string | Optional. Viewers must enter it. It can only be set now, not read or changed later. |
| segment string | string | Optional. Name of a site segment to lock the shared dashboard to. Personal segments are not allowed. |
Request
curl -X POST https://cotlet.dev/api/v1/plausible/shared-links \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"site":"acme-shop.example","name":"Acme monthly","password":"river-lamp-42"}'result = client.call("plausible", "create_shared_link", {"site":"acme-shop.example","name":"Acme monthly","password":"river-lamp-42"})const result = await cotlet.call('plausible', 'create_shared_link', {"site":"acme-shop.example","name":"Acme monthly","password":"river-lamp-42"});cotlet call plausible create_shared_link --data '{"site":"acme-shop.example","name":"Acme monthly","password":"river-lamp-42"}'Example response
{
"site": "acme-shop.example",
"name": "Acme monthly",
"url": "https://plausible.io/share/acme-shop.example?auth=k3T9xQ2mVb7Lw0pD",
"password_protected": true,
"segment": null
}