MEmediamath
Campaigns

List Campaigns

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.

get/campaigns

Request

  • Base URL
    https://api.mediamath.com/api/v3.0
  • Auth
    OAuth 2
    Authorization codehttps://auth.mediamath.com/authorize
    Token URLhttps://auth.mediamath.com/oauth/token
    Scopesoffline_access, manage:services
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

page_limitinteger
Example:100

Number of elements in the collection to retrieve

page_offsetinteger

Index of the first element in the collection to retrieve

sort_bystring
Example:id, -id, name, -name

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.

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,
  • !: - case-insensitive non-match ("does not contain"), allows substring using * wildcards; rows where the field is NULL are excluded,
  • < - 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}.
  • Numeric q=id=:*123* searches are treated as exact primary-key matches, equivalent to q=id==123; likewise q=id!:*123* is equivalent to q=id!=123.
  • q=name!:*promo* to exclude all results whose name contains "promo".
  • 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
Example:*

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

with'advertiser' | 'agency'

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

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.

Response

List campaigns response

OR

Example response

{
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100
  }
}

Changes

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