List Campaigns

The List method uses GET to return a list of campaigns within the network. The list is ordered by the most recent first.

The List method is a case-sensitive query to find the prefix of any words in the name. For example, queries with the following conditions will return a campaign with name “This is a Campaign”:

  • “?name=This”

  • “?name=this”

  • “?name=camp”

Queries with the following conditions will not return above campaign: “?name=ampaign” (no words start with “amp”, though it is part of “Campaign”)

Examples to list Campaigns by various start dates by passing start_date as a URL query parameter:

  • “?start_date=2016-01-01..2017-01-01” will list all Campaigns that began between 2016-01-01 and 2017-01-01

  • “?start_date=..2017-01-01T14:30:14Z” will list all Campaigns that began before 2017-01-01T14:30:14Z

  • “?start_date=2017-01-01T14:30:14Z..” will list all Campaigns that began after 2017-01-01T14:30:14Z If the range is not provided (with “..”), the query will be ignored.

Dates are formatted according to ISO8601, UTC

Language
Credentials
Header