Sign in

v1

latestOpenAPI 3.1.02026-07-263370112.1 KB
ai-referrals

Register AI Referrals Connection

Register an AI Referrals push connection for a (brand, website, provider) tuple. Events can only be pushed once a connection exists.

A brand cannot have both a Google Analytics integration and an active AI Referrals push connection for the same website — the conflicting integration must be disabled first.

MVP provider allow-list: adobe_analytics.

post/{brand_id}/ai-referrals/connections

Path parameters

brand_idinteger required

The unique identifier for the brand.

Request body

websitestring required

Hostname or URL of the website whose referrals will be pushed.

providerstring required

Source analytics provider. MVP allow-list: 'adobe_analytics'.

Example request

{
  "website": "example.com",
  "provider": "adobe_analytics"
}

Response

Connection registered.

idstring required

ULID identifier for the connection.

brand_idinteger required
websitestring required

Hostname or URL of the website whose referrals are pushed against this connection.

providerstring required

Source analytics provider. MVP allow-list: 'adobe_analytics'.

status'active' | 'disabled' required
created_atstring date-time required
last_pushed_atstring date-time nullable
last_push_errorstring nullable

Example response

{
  "provider": "adobe_analytics"
}