Ingest

Create a tracked request

Requires request.create. X-Api-Key is required; sessions are not accepted. Omit projectId only when the key is restricted to exactly one project; global and multiple-project keys must provide it. X-Team-Id is unnecessary and must match the key team when supplied. Missing trafficSource defaults to direct. customData accepts at most 15 top-level keys and 8192 UTF-8 bytes after JSON serialization; omitted or empty customData is returned as null.

POST

requests

A valid request URL is required to generate request examples

{
  "id": "11111111-1111-4111-8111-111111111111",
  "timestamp": "2026-06-01 12:00:00.000",
  "host": "track.example.test",
  "path": "/offer",
  "event": "pageview",
  "visitorId": "visitor-example-1",
  "trafficSource": "newsletter",
  "utmSource": "newsletter",
  "utmMedium": "email",
  "utmCampaign": "example-campaign",
  "utmTerm": "",
  "utmContent": "",
  "clickId": "",
  "sub1": "",
  "sub2": "",
  "sub3": "",
  "sub4": "",
  "sub5": "",
  "sub6": "",
  "sub7": "",
  "sub8": "",
  "customData": null
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "errors": {}
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

X-Api-Key

string

header

required

Body

application/json

projectId

string<uuid>

host

string

path

string

event

string

userAgent

string

visitorId

string

trafficSource

string

utmSource

string

utmMedium

string

utmCampaign

string

utmTerm

string

utmContent

string

clickId

string

sub1

string

sub2

string

sub3

string

sub4

string

sub5

string

sub6

string

sub7

string

sub8

string

customData

object

Show child attributes

Response

Created tracked request.

string

required

timestamp

string

required

ClickHouse UTC timestamp.

host

string

required

path

string

required

event

string

required

visitorId

string

required

trafficSource

string

required

utmSource

string

required

utmMedium

string

required

utmCampaign

string

required

utmTerm

string

required

utmContent

string

required

clickId

string

required

sub1

string

required

sub2

string

required

sub3

string

required

sub4

string

required

sub5

string

required

sub6

string

required

sub7

string

required

sub8

string

required

customData

object | null

required

Show child attributes

A valid request URL is required to generate request examples

{
  "id": "11111111-1111-4111-8111-111111111111",
  "timestamp": "2026-06-01 12:00:00.000",
  "host": "track.example.test",
  "path": "/offer",
  "event": "pageview",
  "visitorId": "visitor-example-1",
  "trafficSource": "newsletter",
  "utmSource": "newsletter",
  "utmMedium": "email",
  "utmCampaign": "example-campaign",
  "utmTerm": "",
  "utmContent": "",
  "clickId": "",
  "sub1": "",
  "sub2": "",
  "sub3": "",
  "sub4": "",
  "sub5": "",
  "sub6": "",
  "sub7": "",
  "sub8": "",
  "customData": null
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "errors": {}
}

{
  "error": "<string>",
  "message": "<string>"
}

Projects

Conversions

Refunds

Chargebacks

Visitors

Requests

Analytics

Dashboards

Pixels

Triggers

Trigger logs

Links

Pages

Domains

Firewall rules

Sales platforms

Traffic sources

Assets

URLs

Ads manager

Ingest

Create a tracked request

Authorizations

Body

Response