GET /emailCampaigns

The response payload for this endpoint has changed You now need to specify which type of statistics you would like to retrieve. For more information visit this page.

Servers

https://api.brevo.com/v3

Query parameters

Name	Type	Required	Description
`endDate`	String	No	Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `endDate` must not be in the future.
`limit`	Integer	No	Number of documents per page Default value: 50
`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. This option only returns data for events that occurred in the last 6 months. For older campaigns, it is advisable to use the Get Campaign Report endpoint. Valid values: `"globalStats"` `"linksStats"` `"statsByDomain"`
`sort`	String	No	Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed Valid values: `"desc"` `"asc"` Default value: "desc"
`type`	String	No	Filter on the type of the campaigns Valid values: `"trigger"` `"classic"`
`status`	String	No	Filter on the status of the campaign Valid values: `"sent"` `"suspended"` `"queued"` `"archive"` `"inProcess"` `"cancelling"` `"draft"` `"inReview"` `"cancelled"`
`startDate`	String	No	Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if `status` is not passed or is set to `sent`. The date range between `startDate` and `endDate` must not exceed 2 years. `startDate` must not be in the future.
`excludePdfAttachment`	Boolean	No	Use this flag to filter out campaigns that have a PDF attachment. If set to true, only campaigns without a PDF attachment (or with no attachment at all) will be returned. Valid values: `true` `false`
`excludeHtmlContent`	Boolean	No	Use this flag to exclude htmlContent from the response body. If set to true, the htmlContent field will be returned as an empty string in the response body. Valid values: `true` `false`
`offset`	Integer	No	Index of the first document in the page Default value: 0

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.