API docs by Redocly

Tracking API (1.0.0)

Download OpenAPI specification:Download

Lead Field and Token management

lead-fields

Find all Lead Fields

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

lead-field-values

Finds all Lead Field Values

Authorizations:
X-Api-Token
query Parameters
filter[parentId]
string <uuid>
Example: filter[parentId]=155ddda2-dbf2-11ec-9f64-02420a00018f

Filter by Parent ID

page
number
Example: page=1
perPage
number
Example: perPage=25
header Parameters
Accept
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Creates a Lead Field Value

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44
Request Body schema: application/json
required
value
required
string
parentIds
required
Array of arrays
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "PPC",
  • "parentIds": [
    ],
  • "isActive": "true"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Finds a Lead Field Value

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates a Lead Field Value

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44
Request Body schema: application/json
required
value
string
parentIds
Array of arrays
isActive
boolean

Responses

Request samples

Content type
application/json
{
  • "value": "PPC",
  • "parentIds": [
    ],
  • "isActive": "true"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a Lead Field Value

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

tokens

Finds all Tokens

Authorizations:
X-Api-Token
query Parameters
filter[leadFieldName]
string <text>
Example: filter[leadFieldName]=origin

Filter by lead fields [id, origin, medium, campaign, audience, targeting, pageType, type, targetUrl]

page
number
Example: page=1
perPage
number
Example: perPage=25
header Parameters
Accept
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

Creates a Token

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44
Request Body schema: application/json
required
origin
required
string
medium
required
string
campaign
required
string
audience
required
string
targeting
required
string
pageType
required
string
type
required
string
targetUrl
required
string <url>
externalEmailId
string or null <uuid>
fromOutsideSource
boolean
giveawayId
string

Responses

Request samples

Content type
application/json
{
  • "origin": "PPC",
  • "medium": "Google Search",
  • "campaign": "Search",
  • "audience": "_",
  • "targeting": "Students",
  • "pageType": "Ads",
  • "type": "New Account",
  • "targetUrl": "https://example.com",
  • "externalEmailId": "fe0d9fc0-9975-332e-b638-853a323b6c6f",
  • "fromOutsideSource": false,
  • "giveawayId": "2e7ce7f6-1f5b-4011-84c6-9eb033e809d4"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Finds a Token

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates a Token

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44
Request Body schema: application/json
required
origin
string
medium
string
audience
string
campaign
string
targeting
string
type
string
pageType
string
targetUrl
string <url>
externalEmailId
string <uuid>
fromOutsideSource
boolean
giveawayId
string

Responses

Request samples

Content type
application/json
{
  • "origin": "PPC",
  • "medium": "Google Search",
  • "audience": "_",
  • "campaign": "Search",
  • "targeting": "Students",
  • "type": "New Account",
  • "pageType": "Ads",
  • "targetUrl": "https://example.com",
  • "externalEmailId": "fe0d9fc0-9975-332e-b638-853a323b6c6f",
  • "fromOutsideSource": false,
  • "giveawayId": "2e7ce7f6-1f5b-4011-84c6-9eb033e809d4"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a Token

Authorizations:
X-Api-Token
header Parameters
Accept
required
string
Default: application/json
Content-Type
required
string
Default: application/json
X-Api-Token
required
string
Default: 4ccb54f5-9885-408e-8bb7-fbc41bb27d44

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}