Sign in
Analytics

List campaign events

Returns paginated raw email events for a specific campaign. Defaults to delivery events.

get/metrics/campaigns/{campaignId}/events

Path parameters

campaignIdstring required

Campaign ID

Query parameters

eventType'send' | 'delivery' | 'bounce' | 'complaint' | 'open' | 'click' | 'unsubscribe' | 'delivery_delay' | 'transport_failure'

Single event type to include. Defaults to delivery when no event type filter is provided.

eventTypesstring
Example:delivery,click

Comma-separated event types to include. Supported values are send, delivery, bounce, complaint, open, click, unsubscribe, delivery_delay, and transport_failure.

period'1h' | '24h' | '7d' | '30d' | '90d'

Sliding time window. Ignored when start and end are provided.

startstring date-time

Start of custom time range (ISO 8601). Must be used with end.

endstring date-time

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

pageinteger

Page number

limitinteger

Events per page (max 500)

includeMachineEngagementboolean

Include detected scanner, preview, and tracked asset open/click events when requesting engagement event types.

Response

Success

successboolean
campaignIdstring
eventTypesstring[]

Example response

{
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 100,
    "totalPages": 5
  }
}

Changes

Changed in 6 of the 123 revisions of this API.3110

  • ba3a29c6eb334See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 8fbabe82a04d1See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 6fd2903b91ce3See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 36f92fc0caa23See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

  • b58891ac1cde11See the full diff
    • ●

      added the new transport_failure enum value to the // response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value transport_failure to the query request parameter eventType

      request-parameter-enum-value-added

  • b6ed7c5f90bc1See the full diff
    • ○

      endpoint added

      endpoint-added