Subscribe to interventions

GET

/edgekit/v1/decide/interventions

const url = 'https://your-tenant-host/edgekit/v1/decide/interventions?domain_userid=7d3f2a1c-5b8e-4f60-9c2d-1e4a6b8c0f37';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://your-tenant-host/edgekit/v1/decide/interventions?domain_userid=7d3f2a1c-5b8e-4f60-9c2d-1e4a6b8c0f37'

Server-sent events for Snowplow’s signals browser plugin, at /edgekit/v1/decide/interventions only. EventSource holds no key and sets no header, so the site comes from the Host, or from x-edgekit-site-id when present. The site proxy sends that header, because behind the proxy the Host is the tenant’s. The stream opens before anything is verified; a failure closes it and the client reconnects (retry: 15–25 s, jittered per stream). Rate limited as POST /edgekit/v1/decide.

Parameters

Query Parameters

domain_userid

Snowplow’s device id; the socket is addressed by it.

string

Example

7d3f2a1c-5b8e-4f60-9c2d-1e4a6b8c0f37

Snowplow’s device id; the socket is addressed by it.

user_id

Snowplow’s user attribute key. Its value is ignored: the user comes from the signed access cookie. One of the two keys is required (400).

string

Snowplow’s user attribute key. Its value is ignored: the user comes from the signed access cookie. One of the two keys is required (400).

Responses

200

An open stream. Each unnamed message event’s data is one JSON intervention in the plugin’s own shape — intervention_id, name, version, target_attribute_key: { name, id }, attributes (always {}); : ping comments keep it alive.

text/event-stream

string

Example

data: {"intervention_id":"…","name":"trial_banner","version":1,"target_attribute_key":{"name":"domain_userid","id":"…"},"attributes":{}}

400

Invalid request.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

422

Request validation failed.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

429

Too many requests. Retry-After says when to retry.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

500

Unexpected error.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

503

With Retry-After, briefly unavailable; without it, not configured.

application/json

object

error

required

object

code

required

string

message

required

string

details

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}