Sharing

Read the board

The public board's address, settings and visible sections.

GET/sites/{siteId}/share

Shared board

curl --request GET \
  --url 'https://truestat.io/api/v1/sites/{siteId}/share' \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "url": "/share/codivupload.com",
    "slug": "codivupload.com",
    "label": null,
    "active": true,
    "panels": {
      "geo": true,
      "tech": true,
      "goals": true,
      "pages": true,
      "funnel": true,
      "heatmap": true,
      "revenue": false,
      "sources": true,
      "ai_panel": true,
      "keywords": false,
      "channel_quality": true,
      "imported_history": false
    },
    "days_left": null,
    "created_at": "2026-09-14T12:00:00.000Z",
    "expires_at": null,
    "updated_at": "2026-09-14T12:00:00.000Z",
    "view_count": 0,
    "max_range_days": 30
  },
  "meta": {
    "site_id": "6fed8980-a119-4a9c-a4d4-53e448ef9f9e"
  }
}

See Shared board for the difference between closing and revoking, how the expiry clock pauses, and why revenue is off by default.

Authorizations

Authorizationstringheaderrequired

An API key from Settings → API keys. Scopes available: analytics:read, sites:read, sites:write, settings:read, settings:write, goals:read, goals:write, funnels:read, funnels:write, notes:read, notes:write, alerts:read, alerts:write, team:read, team:write, revenue:read, revenue:write.

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

Path parameters

siteIdstring (uuid)pathrequired

The site's id, from `GET /sites`. A site that is not yours and a site that does not exist both answer 403, so this cannot be used to discover other people's ids.

Response

application/json

The answer.

dataobject

metaobject

errorobject