PilotFoxDocs

List segments

GET
/api/v1/sites/{siteId}/segments

The segments the caller sees on this site: the site's own and the organization-wide ones, public or their own private ones.

Requires segments:read 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: segments:read

Path Parameters

siteId*string

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/segments'
Example Response200
{  "data": [    {      "id": "string",      "name": "string",      "description": "string",      "filters": [        {          "dim": "string",          "op": "eq",          "values": []        }      ],      "isPublic": true,      "scope": "site",      "createdBy": "string",      "createdAt": "string",      "updatedAt": "string"    }  ]}