GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events

https://api.questline.com/v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events

Gets a list of events for an automated campaign step.

Request Information

URI Parameters

Name Description Type Additional Info
automatedCampaignId The ID of the automated campaign. integer Required
automatedCampaignStepId The ID of the automated campaign step. integer Required

Body Parameters

None.

Filters

Name Description Usage
date Filters the request by date. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events?filter=date~{operator}~{value}
eventType Filters the request by event type. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events?filter=eventtype~{operator}~{value}
subscriberId Filters the request by subscriber ID. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events?filter=subscriberid~{operator}~{value}

Sorting

Name Description Usage
date Sorts the request by date. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events?sort=date~{direction}

Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events?page=index~{value}
size The size of the page when requesting paged results. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/events?page=size~{value}

Response Information

Resource Description

GetAutomatedCampaignStepEventsResponseV3
Name Description Type Additional Info
AutomatedCampaignStepEvents 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.

Response Formats

application/json, text/json

Sample:

{
  "AutomatedCampaignStepEvents": [
    {
      "AutomatedCampaignId": 1,
      "AutomatedCampaignStepId": 1,
      "Date": "2024-11-21T08:58:55.6631341+00:00",
      "EventGuid": "994bda58-75af-496f-982e-e53915392cd2",
      "EventType": "sample string 3",
      "SubscriberId": "290b6af3-7907-47da-b7de-acd60ffd3211",
      "Target": "sample string 5",
      "Data": "sample string 6"
    },
    {
      "AutomatedCampaignId": 1,
      "AutomatedCampaignStepId": 1,
      "Date": "2024-11-21T08:58:55.6631341+00:00",
      "EventGuid": "994bda58-75af-496f-982e-e53915392cd2",
      "EventType": "sample string 3",
      "SubscriberId": "290b6af3-7907-47da-b7de-acd60ffd3211",
      "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"
  }
}

text/javascript, application/javascript, application/json-p

Sample:

/**/ typeof  === 'function' && ({"AutomatedCampaignStepEvents":[{"AutomatedCampaignId":1,"AutomatedCampaignStepId":1,"Date":"2024-11-21T08:58:55.6631341+00:00","EventGuid":"994bda58-75af-496f-982e-e53915392cd2","EventType":"sample string 3","SubscriberId":"290b6af3-7907-47da-b7de-acd60ffd3211","Target":"sample string 5","Data":"sample string 6"},{"AutomatedCampaignId":1,"AutomatedCampaignStepId":1,"Date":"2024-11-21T08:58:55.6631341+00:00","EventGuid":"994bda58-75af-496f-982e-e53915392cd2","EventType":"sample string 3","SubscriberId":"290b6af3-7907-47da-b7de-acd60ffd3211","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"}});