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

Servers

https://apidocs.mediamath.com/

Organizations

Operations

Agencies

Operations

Advertisers

Operations

Campaigns

Operations

Strategies

Operations

Targeting

Operations

Vendor Contracts

Operations

Strategy Templates

Operations

Atomic Creatives

Operations

Concepts

Operations

List Concepts

Request

Get a list of concepts

curl -i -X GET \
  https://apidocs.mediamath.com/concepts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

Create concept

Request

Create a concept

Bodyapplication/json

versioninteger

namestring[ 1 .. 256 ] charactersrequired

statusboolean

curl -i -X POST \
  https://apidocs.mediamath.com/concepts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": 0,
    "name": "string",
    "status": true
  }'

Responses

Concept response

Bodyapplication/json

dataobject(concept_response)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "entity_type": "string",
    "atomic_creative_list": [ … ],
    "version": 0,
    "name": "string",
    "status": true
  },
  "meta": {
    "status": "success"
  }
}

Get a Concept

Request

Get a concept by ID

Path

concept_idintegerrequired

Numeric ID of the concept to get

curl -i -X GET \
  'https://apidocs.mediamath.com/concepts/{concept_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Concept response

Bodyapplication/json

dataobject(concept_response)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "entity_type": "string",
    "atomic_creative_list": [ … ],
    "version": 0,
    "name": "string",
    "status": true
  },
  "meta": {
    "status": "success"
  }
}

Update a concept

Request

Update a concept by ID

Path

concept_idintegerrequired

Numeric ID of the concept to update

Bodyapplication/json

versionintegerrequired

namestring[ 1 .. 256 ] charactersrequired

statusboolean

curl -i -X POST \
  'https://apidocs.mediamath.com/concepts/{concept_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "version": 0,
    "name": "string",
    "status": true
  }'

Responses

Concept response

Bodyapplication/json

dataobject(concept_response)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "entity_type": "string",
    "atomic_creative_list": [ … ],
    "version": 0,
    "name": "string",
    "status": true
  },
  "meta": {
    "status": "success"
  }
}

Concepts Audit Log

Request

Get a list changes to this concept

Path

concept_idintegerrequired

Numeric ID of the concept

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

curl -i -X GET \
  'https://apidocs.mediamath.com/concepts/{concept_id}/history?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

list of changes to an entity

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

Creatives

Operations

Pixel Bundles

Operations

Campaign Plans

Operations

Strategy Plans

Operations

Bulk Update

Operations

Marketplaces

Operations

Users

Operations

Enterprise Controls

Operations

General

Operations

Currency Rates

Operations

Site Lists

Operations

Timezones

Operations

Strategy Groups

Operations

Strategy Day Parts

Operations

Strategy Deals

Operations

Strategy IP Addresses

Operations

Strategy Concepts

Operations

Targeting Segments

Operations

Strategy Target Values

Operations

Contracts

Operations

List Organization Settings

Operations

Update Organization Settings

Operations

New Strategy Plans

Operations

Strategy Plan Target Values

Operations

Campaigns Budget Flights

Operations

User Settings

Operations

Update User Settings

Operations

Healthcheck for Atomic Creatives

Request

Endpoint to check the health of atomic creatives by ID(s).

Query

qstringrequired

Query parameter to specify the atomic creative ID(s). Format:

For multiple IDs: atomic_creative_id==(id1, id2)
For a single ID: atomic_creative_id==id

Examples:

Single ID q=atomic_creative_id==11884513

Multiple IDs q=atomic_creative_id==(11884513, 11884508)

curl -i -X GET \
  'https://apidocs.mediamath.com/atomic_creatives/healthcheck?q=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Healthcheck successful

Response

No content

Verticals

Operations

Audience Vendors

Operations

Supply Sources

Operations

Vendors

Operations

Ad Servers

Operations

Site Lists Site Download

Operations

Site Lists Assignments

Operations

Targeting Segment Objectives

Operations

Targeting Segment Objective

Operations

Contract

Operations

Campaigns API (xx.xx.xx)

Organizations

Agencies

Advertisers

Campaigns

Strategies

Targeting

Vendor Contracts

Strategy Templates

Atomic Creatives

Concepts

List Concepts

Request

Responses

Was this helpful?

Create concept

Request

Responses

Was this helpful?

Get a Concept

Request

Responses

Was this helpful?

Update a concept

Request

Responses

Was this helpful?

Concepts Audit Log

Request

Responses

Was this helpful?

Creatives

Pixel Bundles

Campaign Plans

Strategy Plans

Bulk Update

Marketplaces

Users

Enterprise Controls

General

Currency Rates

Site Lists

Timezones

Strategy Groups

Strategy Day Parts

Strategy Deals

Strategy IP Addresses

Strategy Concepts

Targeting Segments

Strategy Target Values

Contracts

List Organization Settings

Update Organization Settings

New Strategy Plans

Strategy Plan Target Values

Campaigns Budget Flights

User Settings

Update User Settings

Healthcheck for Atomic Creatives

Request

Responses

Was this helpful?

Verticals

Audience Vendors

Supply Sources

Vendors

Ad Servers

Site Lists Site Download

Site Lists Assignments

Targeting Segment Objectives

Targeting Segment Objective

Contract