| Name | Description | Type | Additional Info |
|---|---|---|---|
| automatedCampaignId | The ID of the automated campaign. | integer | Required |
None.
| Name | Description | Usage |
|---|---|---|
| date | Filters the request by date. | GET v3/automatedcampaigns/{automatedCampaignId}/events?filter=date~{operator}~{value} |
| eventType | Filters the request by event type. | GET v3/automatedcampaigns/{automatedCampaignId}/events?filter=eventtype~{operator}~{value} |
| subscriberId | Filters the request by subscriber ID. | GET v3/automatedcampaigns/{automatedCampaignId}/events?filter=subscriberid~{operator}~{value} |
| Name | Description | Usage |
|---|---|---|
| date | Sorts the request by date. | GET v3/automatedcampaigns/{automatedCampaignId}/events?sort=date~{direction} |
| Name | Description | Usage |
|---|---|---|
| index | The index to retrieve when requesting paged results. | GET v3/automatedcampaigns/{automatedCampaignId}/events?page=index~{value} |
| size | The size of the page when requesting paged results. | GET v3/automatedcampaigns/{automatedCampaignId}/events?page=size~{value} |
| Name | Description | Type | Additional Info |
|---|---|---|---|
| AutomatedCampaignEvents | The list of events. | Collection of AutomatedCampaignEventV3 | None. |
| NextPageUrl | The URL of the next page of data for the list. | string | None. |
| PageIndex | The index of the requested page. | integer | None. |
| PageSize | The size of the requested page. | integer | None. |
| TotalPages | The total number of pages, based on total results and page size. | integer | None. |
| TotalResults | The total number of results. | integer | None. |
| Error | The response error, if any. | ResponseErrorV3 | None. |
Sample:
{
"AutomatedCampaignEvents": [
{
"AutomatedCampaignId": 1,
"AutomatedCampaignStepId": 1,
"Date": "2025-11-09T04:50:07.1304884+00:00",
"EventGuid": "cec98cb2-8442-4a2a-8813-3b8586e1bf63",
"EventType": "sample string 3",
"SubscriberId": "2dd7d12c-d42c-4c2b-8f45-72fb974f5738",
"Target": "sample string 5",
"Data": "sample string 6"
},
{
"AutomatedCampaignId": 1,
"AutomatedCampaignStepId": 1,
"Date": "2025-11-09T04:50:07.1304884+00:00",
"EventGuid": "cec98cb2-8442-4a2a-8813-3b8586e1bf63",
"EventType": "sample string 3",
"SubscriberId": "2dd7d12c-d42c-4c2b-8f45-72fb974f5738",
"Target": "sample string 5",
"Data": "sample string 6"
}
],
"NextPageUrl": "sample string 1",
"PageIndex": 1,
"PageSize": 1,
"TotalPages": 1,
"TotalResults": 1,
"Error": {
"ErrorId": 1,
"ErrorMessage": "sample string 1"
}
}
Sample:
/**/ typeof === 'function' && ({"AutomatedCampaignEvents":[{"AutomatedCampaignId":1,"AutomatedCampaignStepId":1,"Date":"2025-11-09T04:50:07.1304884+00:00","EventGuid":"cec98cb2-8442-4a2a-8813-3b8586e1bf63","EventType":"sample string 3","SubscriberId":"2dd7d12c-d42c-4c2b-8f45-72fb974f5738","Target":"sample string 5","Data":"sample string 6"},{"AutomatedCampaignId":1,"AutomatedCampaignStepId":1,"Date":"2025-11-09T04:50:07.1304884+00:00","EventGuid":"cec98cb2-8442-4a2a-8813-3b8586e1bf63","EventType":"sample string 3","SubscriberId":"2dd7d12c-d42c-4c2b-8f45-72fb974f5738","Target":"sample string 5","Data":"sample string 6"}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});