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/

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

Create a Pixel Bundle

Request

Create a pixel bundle

Security
Auth0
Bodyapplication/jsonrequired
event_urlsArray of strings or null
container_tagsArray of strings or null
idinteger>= 1
versioninteger
advertiser_idinteger or null
provider_idinteger or null>= 1
namestring[ 1 .. 64 ] charactersrequired
cost_pct_cpmnumber or null
eligibleboolean
cost_cpmnumber or null
tag_typestringrequired
Enum"dfa""uat""image""iframe""js"
agency_idinteger or null
pricingstring or null
Enum"CPM""CPTS"
cost_cptsnumber or null
pixel_typestringrequired
Enum"creative""event""data""segment""dynamic"
segment_opstring or null
Enum"AND""OR"
rmx_friendlyboolean
rmx_meritboolean
rmx_pc_window_minutesinteger or null
rmx_pv_window_minutesinteger or null
rmx_conversion_typestring
Enum"one""variable"
rmx_conversion_minutesinteger
currencystring or null
Enum"S1""S2""V1""V2"
revenuestring or null
Enum"S1""S2""V1""V2"
currency_fixedstring or null
statusboolean
contianer_tagsArray of strings or null
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/pixel_bundles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "event_urls": [
      "string"
    ],
    "container_tags": [
      "string"
    ],
    "id": 1,
    "version": 0,
    "advertiser_id": 0,
    "provider_id": 1,
    "name": "string",
    "cost_pct_cpm": 0,
    "eligible": true,
    "cost_cpm": 0,
    "tag_type": "dfa",
    "agency_id": 0,
    "pricing": "CPM",
    "cost_cpts": 0,
    "pixel_type": "creative",
    "segment_op": "AND",
    "rmx_friendly": true,
    "rmx_merit": true,
    "rmx_pc_window_minutes": 0,
    "rmx_pv_window_minutes": 0,
    "rmx_conversion_type": "one",
    "rmx_conversion_minutes": 0,
    "currency": "S1",
    "revenue": "S1",
    "currency_fixed": "string",
    "status": true,
    "contianer_tags": [
      "string"
    ]
  }'

Responses

Pixel bundle created response

Bodyapplication/json
dataobject(pixel_bundle_base)
metaobject
Response
application/json
{ "data": { "id": 1, "version": 0, "advertiser_id": 0, "provider_id": 1, "name": "string", "cost_pct_cpm": 0, "eligible": true, "tags": "string", "cost_cpm": 0, "external_identifier": "string", "tag_type": "dfa", "agency_id": 0, "pricing": "CPM", "cost_cpts": 0, "pixel_type": "creative", "segment_op": "AND", "rmx_friendly": true, "rmx_merit": true, "rmx_pc_window_minutes": 0, "rmx_pv_window_minutes": 0, "rmx_conversion_type": "one", "rmx_conversion_minutes": 0, "currency": "S1", "revenue": "S1", "currency_fixed": "string", "status": true, "event_urls": [], "contianer_tags": [] }, "meta": { "status": "success" } }

List Pixel Bundles

Request

Get a list of pixel bundles

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.
withstring

Get related property in response

Value"organization"
fullstring

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

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

Responses

Pixel bundles response

Bodyapplication/json
One of:
dataArray of objects or null
metaobject(pagination metadata)
Response
application/json
{ "data": { "id": 1, "version": 0, "advertiser_id": 0, "provider_id": 1, "name": "string", "cost_pct_cpm": 0, "eligible": true, "tags": "string", "cost_cpm": 0, "external_identifier": "string", "tag_type": "dfa", "agency_id": 0, "pricing": "CPM", "cost_cpts": 0, "pixel_type": "creative", "segment_op": "AND", "rmx_friendly": true, "rmx_merit": true, "rmx_pc_window_minutes": 0, "rmx_pv_window_minutes": 0, "rmx_conversion_type": "one", "rmx_conversion_minutes": 0, "currency": "S1", "revenue": "S1", "currency_fixed": "string", "status": true, "event_urls": [], "contianer_tags": [] }, "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }

Update a Pixel Bundle

Request

Update a pixel bundle by ID

Security
Auth0
Path
pixel_bundle_idintegerrequired

Numeric ID of the pixel bundle to update

Bodyapplication/jsonrequired
idinteger>= 1
versioninteger
advertiser_idinteger or null
provider_idinteger or null>= 1
namestring[ 1 .. 64 ] characters
cost_pct_cpmnumber or null
eligibleboolean
cost_cpmnumber or null
tag_typestring
Enum"dfa""uat""image""iframe""js"
agency_idinteger or null
pricingstring or null
Enum"CPM""CPTS"
cost_cptsnumber or null
pixel_typestring
Enum"creative""event""data""segment""dynamic"
segment_opstring or null
Enum"AND""OR"
rmx_friendlyboolean
rmx_meritboolean
rmx_pc_window_minutesinteger or null
rmx_pv_window_minutesinteger or null
rmx_conversion_typestring
Enum"one""variable"
rmx_conversion_minutesinteger
currencystring or null
Enum"S1""S2""V1""V2"
revenuestring or null
Enum"S1""S2""V1""V2"
currency_fixedstring or null
statusboolean
event_urlsArray of strings or null
contianer_tagsArray of strings or null
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/pixel_bundles/{pixel_bundle_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 1,
    "version": 0,
    "advertiser_id": 0,
    "provider_id": 1,
    "name": "string",
    "cost_pct_cpm": 0,
    "eligible": true,
    "cost_cpm": 0,
    "tag_type": "dfa",
    "agency_id": 0,
    "pricing": "CPM",
    "cost_cpts": 0,
    "pixel_type": "creative",
    "segment_op": "AND",
    "rmx_friendly": true,
    "rmx_merit": true,
    "rmx_pc_window_minutes": 0,
    "rmx_pv_window_minutes": 0,
    "rmx_conversion_type": "one",
    "rmx_conversion_minutes": 0,
    "currency": "S1",
    "revenue": "S1",
    "currency_fixed": "string",
    "status": true,
    "event_urls": [
      "string"
    ],
    "contianer_tags": [
      "string"
    ]
  }'

Responses

Pixel bundle updated response

Bodyapplication/json
dataobject(pixel_bundle_base)
metaobject
Response
application/json
{ "data": { "id": 1, "version": 0, "advertiser_id": 0, "provider_id": 1, "name": "string", "cost_pct_cpm": 0, "eligible": true, "tags": "string", "cost_cpm": 0, "external_identifier": "string", "tag_type": "dfa", "agency_id": 0, "pricing": "CPM", "cost_cpts": 0, "pixel_type": "creative", "segment_op": "AND", "rmx_friendly": true, "rmx_merit": true, "rmx_pc_window_minutes": 0, "rmx_pv_window_minutes": 0, "rmx_conversion_type": "one", "rmx_conversion_minutes": 0, "currency": "S1", "revenue": "S1", "currency_fixed": "string", "status": true, "event_urls": [], "contianer_tags": [] }, "meta": { "status": "success" } }

Get a Pixel Bundle

Request

Get a pixel bundle by ID

Security
Auth0
Path
pixel_bundle_idintegerrequired

Numeric ID of the pixel bundle to get

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/pixel_bundles/{pixel_bundle_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Pixel bundle response

Bodyapplication/json
dataobject(pixel_bundle_base)
metaobject
Response
application/json
{ "data": { "id": 1, "version": 0, "advertiser_id": 0, "provider_id": 1, "name": "string", "cost_pct_cpm": 0, "eligible": true, "tags": "string", "cost_cpm": 0, "external_identifier": "string", "tag_type": "dfa", "agency_id": 0, "pricing": "CPM", "cost_cpts": 0, "pixel_type": "creative", "segment_op": "AND", "rmx_friendly": true, "rmx_merit": true, "rmx_pc_window_minutes": 0, "rmx_pv_window_minutes": 0, "rmx_conversion_type": "one", "rmx_conversion_minutes": 0, "currency": "S1", "revenue": "S1", "currency_fixed": "string", "status": true, "event_urls": [], "contianer_tags": [] }, "meta": { "status": "success" } }

Pixel Bundle Audit Log

Request

Get a list changes to this pixel bundle

Security
Auth0
Path
pixel_bundle_idintegerrequired

Numeric ID of the pixel bundle

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://api.mediamath.com/api/v3.0/pixel_bundles/{pixel_bundle_id}/history?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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

Pixel Providers

Pixel Providers

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

User Permissions

User Permissions

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

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