Skip to content
/
List Roles

Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://mediamathsupport.force.com/

Support

developers@mediamath.com

Languages
Servers
Live Server

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

Organizations

Organizations

Operations

Agencies

Agencies

Operations

Advertisers

Advertisers

Operations

Campaigns

Campaigns

Operations

Campaigns Budget Flights

Campaigns Budget Flights

Operations

Campaign Plans

Campaign Plans

Operations

Strategies

Strategies

Operations

Strategy Parameters

Strategy Parameters

Operations

Strategy Templates

Strategy Templates

Operations

New Strategy Plans

New Strategy Plans

Operations

Targeting

Targeting

Operations

Targeting Attachments

TargetingAttachments

Operations

Targeting Segments

Targeting Segments

Operations

Targeting Segment Objectives

Targeting Segment Objectives

Operations

Vendor Contracts

Vendor Contracts

Operations

Contracts

Contracts

Operations

Audience Vendors

Audience Vendors

Operations

Vendors

Vendors

Operations

Atomic Creatives

Atomic Creatives

Operations

Concepts

Concepts

Operations

Creatives

Creatives

Operations

Pixel Bundles

Pixel Bundles

Operations

Pixel Providers

Pixel Providers

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

User Permissions

User Permissions

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

Health Check

Request

Health endpoint to check availability

Security
Auth0
curl -i -X GET \
  https://api.mediamath.com/api/v3.0/healthcheck \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Health check response

Bodyapplication/json
build_versionstring
build_datestring
database_connectionboolean
latencystring

next format is used: 5 ms for latency more than 1ms and 5 µs for latency less than 1ms

node_connsobject
node_max_connsinteger
node_total_consinteger
Response
application/json
{
  "build_version": "string",
  "build_date": "string",
  "database_connection": true,
  "latency": "string",
  "node_conns": {
    "acquired": 0,
    "constucting": 0,
    "idle": 0
  },
  "node_max_conns": 0,
  "node_total_cons": 0
}

List Roles

Request

Get list of roles

Security
Auth0
curl -i -X GET \
  https://api.mediamath.com/api/v3.0/roles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List roles response

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"
  }
}

Search Entities

Request

Search organizations, agencies or advertisers by name

Security
Auth0
Query
limitinteger<= 1000

number of elements in the collection to retrieve

Default 10
namestringrequired

search term

active_onlyboolean

only show active entities

terminatedboolean

show terminated entities

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/search?limit=10&name=string&active_only=true&terminated=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Search result

Bodyapplication/json
dataobject
metaobject(pagination metadata)
Response
application/json
{
  "data": {
    "organizations": [ … ],
    "agencies": [ … ],
    "advertisers": [ … ]
  },
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

List Target Values

Request

Get list of target values

Security
Auth0
Query
namestring

Search name

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/target_values?name=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List target values response

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"
  }
}

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

Timezones

Timezones

Operations

Verticals

Verticals

Operations

Supply Sources

Supply Sources

Operations

Ad Servers

Ad Servers

Operations

Segment Groups

Segment Groups

Operations