Skip to content

Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
Languages
Servers
Live Server

https://api.mediamath.com/api/v3.0/

Operations
Operations
Operations
Operations

Campaigns Budget Flights

Campaigns Budget Flights

Operations
Operations
Operations

Strategy Parameters

Strategy Parameters

Operations

Strategy Templates

Strategy Templates

Operations

New Strategy Plans

New Strategy Plans

Operations
Operations

Request

Audience segments CPM estimate

Security
Auth0
Bodyapplication/json

Audience segments CPM estimate request

currency_codestring= 3 charactersrequired
Example: "USD"
includeArray of objects(audience_segments_group)
excludeobject(audience_segments_group)
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/audience_segments/cpm_estimate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency_code": "USD",
    "include": [
      {
        "operator": "AND",
        "segments": [
          {
            "audience_segment_id": 0
          }
        ]
      }
    ],
    "exclude": {
      "operator": "AND",
      "segments": [
        {
          "audience_segment_id": 0
        }
      ]
    }
  }'

Responses

Audience segments CPM estimate response

Bodyapplication/json
dataobject
metaobject(single_metadata)
Response
application/json
{ "data": { "cpm": {} }, "meta": { "status": "success" } }

Request

Get list of technology target values

Security
Auth0
Query
namestring

Case insensitive name contains search

full_pathstring

Case insensitive full_path contains search

dimension_codestringrequired

Comma separated list of dimension codes

sort_bystring

field to sort by (ascending default, prepend '-' for descending)

qstring

common query searching and pattern matching for fields

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/technology_target_values?name=string&full_path=string&dimension_code=string&sort_by=string&q=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List technology target values

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

Request

Get a list of contextual segments

Security
Auth0
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.

  • 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) find specific entities by ID.
fullstring

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

Example: full=*
currency_codestring= 3 characters

If not provided, the default currency (USD) will be used.

Example: currency_code=USD
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/path_targeting_segments?page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string&full=*&currency_code=USD' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List targeting segments response

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

Targeting Attachments

TargetingAttachments

Operations

Targeting Segments

Targeting Segments

Operations

Targeting Segment Objectives

Targeting Segment Objectives

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Enterprise Controls

Enterprise Controls

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations