ai-referrals

Register AI Referrals Connection

A website reads from one source at a time: one with Google Analytics connected, or an active connection already, returns 409.

Use provider custom for any analytics tool; adobe_analytics is also accepted.

post/{brand_id}/ai-referrals/connections

Request

Base URL
https://api.scrunchai.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/scrunch/apis/scrunch-data-api/docs/:brand_id/ai-referrals/connections/post.ts
A function with typed inputs. Its response is checked against the schema.

brand_idinteger required

The unique identifier for the brand.

websitestring required

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

provider'custom' | 'adobe_analytics' required

Where the data comes from: "custom" for any analytics tool, or "adobe_analytics". Both are read the same way.

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

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.

provider'custom' | 'adobe_analytics' required

Where the data comes from: "custom" for any analytics tool, or "adobe_analytics". Both are read the same way.

status'active' | 'disabled' required

created_atstring date-time required

last_pushed_atstring date-time nullable

last_push_errorstring nullable

sends_engagementboolean

Whether the connection's rows carry users, engagement and key events. Set by its first push.

{
  "provider": "custom"
}