GEgetfrontline
Campaigns

List campaign tracking events

Changed on
get/public/v1/campaigns/{campaignId}/events

Request

Path parameters

campaignIdstring cuid required
Example:example

Query parameters

pageNuminteger
Example:1
pageSizeinteger
Example:1
type'SENT' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'REPLIED' | 'FAILED' | 'BOUNCED' | 'COMPLAINED' | 'UNSUBSCRIBED' | 'CONVERTED'
Example:SENT
string uuid
OR
string cuid
Example:550e8400-e29b-41d4-a716-446655440000

Response

Campaign events

countnumber
pageSizenumber required
pageNumnumber
totalPagesnumber
cursornumber
paginationType'offset' | 'cursor'

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "cursor": 1,
  "results": [
    {
      "id": "example",
      "type": "example",
      "occurredAt": "2024-01-01T12:00:00.000Z",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "displayName": "example",
      "destination": "example"
    }
  ],
  "paginationType": "offset",
  "nextCursor": "example"
}

Changes