GET /emailCampaigns/{campaignId}

Retrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content. Use the statistics query parameter to select which statistics to include (globalStats, linksStats, statsByDomain, statsByDevice, or statsByBrowser); statsByDevice and statsByBrowser are only available on this single-campaign endpoint. You can exclude HTML content from the response by setting excludeHtmlContent to true.

Servers

Path parameters

Name Type Required Description
campaignId Integer Yes

Id of the campaign

Query parameters

Name Type Required Description
statistics String No

Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. statsByDevice and statsByBrowser are only available when retrieving a single campaign (not in the list endpoint).

Valid values:

  • "globalStats"
  • "statsByBrowser"
  • "linksStats"
  • "statsByDomain"
  • "statsByDevice"
excludeHtmlContent Boolean No

Use this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body

Valid values:

  • true
  • false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.