Skip to main content

Sharing

Publish or update

Create the board, or change what it shows.

PUT/sites/{siteId}/share
Publish or update the board
curl --request PUT \
  --url 'https://truestat.io/api/v1/sites/{siteId}/share' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "geo": false,
  "tech": false,
  "goals": false,
  "label": "<string>",
  "pages": false,
  "funnel": false,
  "heatmap": false,
  "revenue": false,
  "sources": false,
  "ai_panel": false,
  "keywords": false,
  "max_range_days": 0,
  "channel_quality": false,
  "expires_in_days": 0,
  "imported_history": false
}'
{
  "data": {
    "url": "/share/codivupload.com",
    "slug": "codivupload.com",
    "label": "Q3 report",
    "active": true,
    "panels": {
      "pages": true,
      "revenue": false,
      "sources": true
    },
    "days_left": null,
    "created_at": "2026-09-14T12:00:00.000Z",
    "expires_at": "2026-10-16T19:00:00.000Z",
    "updated_at": "2026-09-16T19: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.

Request bodyapplication/json

geobooleanbody
Whether this section appears on the board.
techbooleanbody
Whether this section appears on the board.
goalsbooleanbody
Whether this section appears on the board.
labelstringbody
Shown to whoever opens the board.
pagesbooleanbody
Whether this section appears on the board.
funnelbooleanbody
Whether this section appears on the board.
heatmapbooleanbody
Whether this section appears on the board.
revenuebooleanbody
Whether this section appears on the board.
sourcesbooleanbody
Whether this section appears on the board.
ai_panelbooleanbody
Whether this section appears on the board.
keywordsbooleanbody
Whether this section appears on the board.
max_range_daysintegerbody
How far back a viewer may look. Separate from your plan's retention — you may keep three years and show one month.
channel_qualitybooleanbody
Whether this section appears on the board.
expires_in_daysintegerbody
Days from now until it expires, or null for no expiry. Restarts on every save.
imported_historybooleanbody
Whether this section appears on the board.

Response

application/json

The answer.

dataobject
metaobject