api-docs-icon

Get Campaign Events

GET
/ api/ v1/ campaigns/ {id}/ events

Retrieve the most recent events for the specified campaign. Results will be paged so it will be necessary to pass in PageNumber and PageSize to get all events. PageSize has a maximum value of 100. Possible event names that will be returned are: ‘Mail Piece Created’, ‘Addressed’, ‘Mailed’,'In Transit', 'In Local Area', 'Processed for Delivery', 'Returned To Sender', 'Re-Routed', ‘pURL Opened’ or ‘purl Completed’

Within the return data array, each event will have the following elements:

  • For online activity, the metadata contains the visited URL.
  • For offline activity the metadata is empty

id
integer (int32)
required

Integer contains the Campaign Drop Id of the object to retrieve

PageNumber
integer (int32)
default: 1

What page in the results to be returned.

PageSize
integer (int32)
default: 100

The number of items per page. Max is 100.

Response

application/json
array[object]
object

Code Examples

Response