PilotFoxDocs
REST APIAPI referenceGoals

Create a goal

POST
/api/v1/sites/{siteId}/goals

A named condition (a page, an event or an autocaptured interaction) whose sessions count as conversions. 409 once the site has 100 goals.

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

Path Parameters

siteId*string

Request Body

application/json
  1. body
name*string
Length1 <= length <= 100
condition*||
icon?|null

Response Body

Created

application/json
  1. response
data*
Example Request
curl -X POST 'https://pilotfox.app/api/v1/sites/string/goals' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "condition": {    "kind": "page",    "path": "string"  }}'
Example Response201
{  "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"  }}

List goals GET

Previous Page

Preview a goal POST

Next Page