Campaign Event Stream

curl --request GET \
  --url https://api.example.com/v1/campaigns/{id}/events

{
  "data": {
    "events": [
      {
        "id": "<string>",
        "type": "<string>",
        "contact_id": "<string>",
        "email": "<string>",
        "step_id": "<string>",
        "timestamp": "<string>",
        "metadata": {}
      }
    ]
  },
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

GET

campaigns

{id}

events

Campaign Event Stream

curl --request GET \
  --url https://api.example.com/v1/campaigns/{id}/events

{
  "data": {
    "events": [
      {
        "id": "<string>",
        "type": "<string>",
        "contact_id": "<string>",
        "email": "<string>",
        "step_id": "<string>",
        "timestamp": "<string>",
        "metadata": {}
      }
    ]
  },
  "meta": {
    "page": 123,
    "per_page": 123,
    "total": 123
  }
}

Request

Path Parameters

string

required

The campaign’s unique ID (UUID)

Query Parameters

page

integer

default:"1"

Page number for pagination

per_page

integer

default:"50"

Events per page (max: 100)

type

string

Filter by event type: sent, delivered, opened, clicked, replied, bounced, unsubscribed, complained

contact_id

string

Filter events for a single contact (UUID)

from_date

string

Only events on or after this ISO 8601 timestamp

to_date

string

Only events on or before this ISO 8601 timestamp

Headers

Authorization: Bearer wbk_your_api_key_here

Requires an API key with the campaigns:read permission. Events are retained for 180 days.

Response

data

object

Show properties

events

array

Array of event objects, newest first.

Show Event object

string

Event UUID

type

string

Event type (see type query filter)

contact_id

string

Contact UUID

string

Contact’s email address at the time of the event

step_id

string

Step UUID the event relates to

timestamp

string

ISO 8601 timestamp of the event

metadata

object

Event-specific metadata (e.g., clicked URL, bounce reason, user agent)

Example Response

{
  "data": {
    "events": [
      {
        "id": "evt_a1b2c3d4",
        "type": "opened",
        "contact_id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "jane@example.com",
        "step_id": "step_1",
        "timestamp": "2026-04-17T14:23:05Z",
        "metadata": {
          "user_agent": "Mozilla/5.0 ...",
          "ip_country": "DE"
        }
      },
      {
        "id": "evt_b2c3d4e5",
        "type": "clicked",
        "contact_id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "jane@example.com",
        "step_id": "step_1",
        "timestamp": "2026-04-17T14:23:42Z",
        "metadata": {
          "url": "https://leadlex.com/demo"
        }
      }
    ]
  },
  "meta": { "page": 1, "per_page": 100, "total": 2341 }
}

Errors

Status	Code	Description
400	`invalid_event_type`	Unrecognized `type` value
401	`invalid_key`	Invalid or expired API key
403	`insufficient_permissions`	Missing `campaigns:read` permission
404	`campaign_not_found`	No campaign with this ID
429	`rate_limited`	Rate limit exceeded

Campaign Stats List Users

​Request

​Path Parameters

​Query Parameters

​Headers

​Response

​Example Response

​Errors

Request

Path Parameters

Query Parameters

Headers

Response

Example Response

Errors