Skip to main content
POST
Push AI Referrals Events

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required

The unique identifier for the brand.

connection_id
string
required

The ULID of the AI Referrals connection.

Body

date
string<date>
required

UTC calendar day the metrics cover.

Example:

"2026-05-20"

raw_referrer_value
string
required

Raw referrer value as emitted by the source analytics tool (e.g. 'chatgpt.com'). Normalized server-side against the AI platform allow-list.

Required string length: 1 - 512
Example:

"chatgpt.com"

raw_page_value
string
required

Raw page identifier from the source tool (URL path for GA4-shape tools; page name for Adobe unless a URL eVar is configured).

Required string length: 1 - 2048
Example:

"/blog/launch-notes"

pageviews
integer | null
Required range: x >= 0
sessions
integer | null
Required range: x >= 0
transactions
integer | null
Required range: x >= 0
purchase_revenue
number | null
Required range: x >= 0
batch_id
string | null

Optional client-supplied batch identifier for traceability.

Maximum string length: 128

Response

Batch accepted.

Outcome of a push batch submission.

accepted
integer
required

Number of events accepted into the unified referrals store.

rejected
integer
required

Number of events dropped (e.g. referrer not on the AI platform allow-list).

errors
string[]

Per-row diagnostic messages, truncated.