Get information about all Smart Campaigns

get

https://api.campaign.episerver.net/rest/{clientId}/smartcampaigns

Get detailed information about all Smart Campaigns, such as mailing IDs and the date and time of creation.

Path Params

clientId

int64

required

Client ID

Query Params

offset

int32

Starting point of the result list

Default value : 0

limit

int32

Maximum number of retrieved campaigns

Default value : 100

mediaType

string

Filter mailings by media type

Available values : email, sms, letter, push

resultView

string

enum

Defaults to SUMMARY

Choose whether to retrieve a DETAILED view including all nodes (messages, recipient lists, target groups) or a SUMMARY of metadata.

Note: The more campaigns you have, the more time the detailed view takes to load.

Allowed:

status

string

Filter mailings by status

Available values : invalid, activationRequired, activated, canceled, paused, running, finished

sort

string

enum

Defaults to created

Sort result by specific criteria

folderId

int64

Filter mailings assigned to a folder

direction

string

enum

Sort order

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Invalid limit request. Change the limit to less than 10000.

Language

Credentials

Header

Response

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

application/json

application/vnd.optivo.broadmail.v1+json

200The Smart Campaigns were retrieved successfully (empty result if none was found).