emailCampaigns

Return all your created email campaigns

<Note>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.</Note>

get/emailCampaigns

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/emailCampaigns
  • Auth: API key in header api-key

Query parameters

type'classic' | 'trigger'

Filter on the type of the campaigns

status'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess' | 'inReview' | 'cancelling' | 'cancelled'

Filter on the status of the campaign

statistics'globalStats' | 'linksStats' | 'statsByDomain'

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.

startDatestring

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.

endDatestring

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.

limitinteger

Number of documents per page

offsetinteger

Index of the first document in the page

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

excludeHtmlContentboolean

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.

excludePdfAttachmentboolean

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.

Response

Email campaigns information

countinteger

Number of Email campaigns retrieved

Changes

No recorded changes to this operation across all 1 revision of this API.