Get all campaigns (with filters)

get

https://{region}-api.dotdigital.com/v2/campaigns/filtered

Gets all campaigns, with optional filtering.

Query Params

select

int32

1 to 1000

Defaults to 1000

The number of records to select between 1 and 1000 to retrieve.

skip

int32

≥ 1

The numbers of records to skip in the result set.

~type

string

enum

Filter to a specific type of email campaign.

Allowed:

~tags

array of strings

Filter to campaigns with the specified tags; all tags listed must be assigned to the campaign to be included.

~tags

~sentDate

date

Filter for campaigns sent on or after the specified date-time in UTC ISO-8601 format.

~statuses

array of strings

Filter by campaign statuses: Unsent, Sent, Sending, Paused, Cancelled, RequiresWorkflowApproval

~statuses

~scheduledDateFrom

date

Filter for campaigns scheduled to be sent on or after the specified date-time in UTC ISO-8601 format. Can be used in conjunction with ~scheduledDateTo to create a date window.

~scheduledDateTo

date

Filter for campaigns scheduled to be sent on or before the specified date-time in UTC ISO-8601 format. Can be used in conjunction with ~scheduledDateFrom to create a date window.

Headers

x-ddg-integration-token

string

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/plain

200200

400400

401401