PilotFoxDocs

Create a share link

POST
/api/v1/sites/{siteId}/share-links

A read-only link to the site's dashboard with scopes (analytics:read, sessions:read, users:read, replay:read; analytics:read by default), each one the caller holds on the site (403 otherwise), and an optional expiresAt in the future. This answer is the only one that carries the token and the link's URL (<PUBLIC_URL>/share/<token>). Not with an MCP OAuth token (403).

Requires shareLink:write on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: shareLink:write

Path Parameters

siteId*string

Request Body

application/json
  1. body
name?string
Length1 <= length <= 100
scopes?array<>
Items1 <= items
Default
[  "analytics:read"]
expiresAt?|null

Response Body

Created

application/json
  1. response
data*
Example Request
curl -X POST 'https://pilotfox.app/api/v1/sites/string/share-links' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response201
{  "data": {    "id": "string",    "token": "string",    "url": "string"  }}