Account

Read site settings

What this site accepts, excludes and how it identifies visitors.

GET/sites/{siteId}/settings

Site settings

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

{
  "data": {
    "name": "codivupload.com",
    "active": true,
    "domain": "codivupload.com",
    "excluded_paths": [],
    "session_strategy": "first_party_cookie",
    "allowed_hostnames": [
      "codivupload.com",
      "www.codivupload.com"
    ],
    "excluded_countries": [],
    "excluded_hostnames": [
      "app.codivupload.com"
    ]
  },
  "meta": {
    "site_id": "6fed8980-a119-4a9c-a4d4-53e448ef9f9e"
  }
}

The current configuration, as the collector applies it.

Needs settings:read — a narrower permission than the one that changes these values. An integration that only needs to report on how a site is set up does not need to be able to reconfigure it.

See Change site settings for what each field does and why every change applies forwards only.

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