Skip to content
/
List Campaigns

List Campaigns

Request

Get a list of campaigns. The data fetched for each campaign depends on the values of query params. For example, if you use query parameter full all properties are fetched.

Security
Auth0(Required scopes: offline_accessmanage:services)
Query
page_limitinteger, [ 1 .. 1000 ]

Number of elements in the collection to retrieve

Example:page_limit=100
page_offsetinteger, [ 0 .. 1000 ]

Index of the first element in the collection to retrieve

Example:page_offset=0
sort_bystring

The field to sort by. You can use any field name in ascending or descending order. For ascending order, use the field name directly, e.g., id. For descending order, prefix the field name with a hyphen (-), e.g., -id.

Example:sort_by=id, -id, name, -name
qstring

Query search for filtering. This parameter can be used to filter results based on various fields. Supported operators:

  • == - numeric equality or case-sensitive string identity,
  • ==(1,2,3) - IN query (only works for integers),
  • != - numeric inequality or case-sensitive string non-identity,
  • =: - case-insensitive match, allows substring using * wildcards,
  • < - less than,
  • <= - less than or equal to,
  • > - greater than,
  • >= - greater than or equal to. Examples:
  • q=name=:{search}* to find all results with names starting with {search}.
  • q=status==true to find all active entities.
  • q=id>=1000 to find all entities with id greater than or equal to 1000.
  • q=id==(1,2,3) to find specific entities by ID.
  • q=created_on>1999-02-02 or q=created_on>1999-02-02T00:00:00Z to find entities created later than date.
  • q=id>5&status==true to find all active entities with id greater than 5.
fullstring

To return all fields, set the value to *. For example, full=* will include all properties.

Example:full=*
withstring

Get related property in response, values can be combined via , (example: agency,advertiser)

Enum:"advertiser""agency"
live_onlyboolean

If provided and true only campaigns with start_date < now and end_date > now will be returned. Default value is false. Cannot be combined with filter_expired=true.

filter_expiredboolean

If provided and true only campaigns with end_date > now will be returned. Default value is false. Cannot be combined with live_only=true.

GET
/campaigns
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/campaigns?page_limit=100&page_offset=0&sort_by=id%2C%20-id%2C%20name%2C%20-name&q=string&full=*&with=advertiser&live_only=true&filter_expired=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List campaigns response

Bodyapplication/json
Any of:
dataArray of objects(campaign_with)
metaobject(pagination metadata)
Response
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}