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

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

Gets an automated campaign step report.

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
endDate Filters the request by end date. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/report?filter=enddate~{operator}~{value}
startDate Filters the request by start date. GET v3/automatedcampaigns/{automatedCampaignId}/steps/{automatedCampaignStepId}/report?filter=startdate~{operator}~{value}

Response Information

Resource Description

GetAutomatedCampaignStepReportResponseV3
Name Description Type Additional Info
AutomatedCampaignStepReport The automated campaign step report. AutomatedCampaignStepReportV3 None.
Error The response error, if any. ResponseErrorV3 None.

Response Formats

application/json, text/json

Sample:

{
  "AutomatedCampaignStepReport": {
    "AutomatedCampaignId": 1,
    "AutomatedCampaignStepId": 2,
    "StepType": "sample string 3",
    "EmailStats": {
      "DeliveryRate": 1.1,
      "TotalSent": 2,
      "Delivered": 3,
      "Failed": 4,
      "OpenRate": 5.1,
      "TotalOpens": 6,
      "UniqueOpens": 7,
      "ClickToOpenRate": 8.1,
      "TotalClicks": 9,
      "UniqueClicks": 10,
      "ClickThroughRate": 11.1,
      "OptOuts": 12,
      "OptOutRate": 13.1,
      "SpamComplaints": 14,
      "TotalBounces": 15,
      "BlockedBounces": 16,
      "HardBounces": 17
    }
  },
  "Error": {
    "ErrorId": 1,
    "ErrorMessage": "sample string 1"
  }
}

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

Sample:

/**/ typeof  === 'function' && ({"AutomatedCampaignStepReport":{"AutomatedCampaignId":1,"AutomatedCampaignStepId":2,"StepType":"sample string 3","EmailStats":{"DeliveryRate":1.1,"TotalSent":2,"Delivered":3,"Failed":4,"OpenRate":5.1,"TotalOpens":6,"UniqueOpens":7,"ClickToOpenRate":8.1,"TotalClicks":9,"UniqueClicks":10,"ClickThroughRate":11.1,"OptOuts":12,"OptOutRate":13.1,"SpamComplaints":14,"TotalBounces":15,"BlockedBounces":16,"HardBounces":17}},"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});