PilotFoxDocs

Get a goal

GET
/api/v1/sites/{siteId}/goals/{id}

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

Path Parameters

siteId*string
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/goals/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response200
{  "data": {    "id": "string",    "name": "string",    "condition": {      "kind": "page",      "path": "string",      "hostname": "string",      "props": [        {          "key": "string",          "op": "eq",          "value": "string"        }      ]    },    "icon": "string",    "createdAt": "string",    "updatedAt": "string"  }}