Pixel Bundles

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
Mock server
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/

Organizations

Organizations

Operations

Agencies

Agencies

Operations

Advertisers

Advertisers

Operations

Campaigns

Campaigns

Operations

Strategies

Strategies

Operations

Targeting

Targeting

Operations

Vendor Contracts

Vendor Contracts

Operations

Strategy Templates

Strategy Templates

Operations

Atomic Creatives

Atomic Creatives

Operations

Concepts

Concepts

Operations

Creatives

Creatives

Operations

Pixel Bundles

Pixel Bundles

Operations

Create A Pixel Bundle

Request

Create a new Pixel Bundle

Bodyapplication/jsonrequired
idinteger>= 1
versioninteger
advertiser_idinteger or nullrequired
provider_idinteger or null>= 1
namestring[ 1 .. 64 ] charactersrequired
cost_pct_cpmnumber or null
eligibleboolean
tagsstring or null
cost_cpmnumber or null
external_identifierstring
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
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/pixel_bundles \
  -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,
    "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
  }'

Responses

Pixel Bundle has been created successfully

Bodyapplication/json
dataobject(pixel_bundle)
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
  },
  "meta": {
    "status": "success"
  }
}

List Pixel Bundles

Request

Get a list of Pixel Bundles

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

Get related property in response

Value"organization"
fullstring

Use this parameter to specify which properties to include in the response. To return all fields, set the value to *. For example, full=* will include all properties

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

Responses

list of Pixel Bundles

Bodyapplication/json
One of:
dataArray of objects
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
  },
  "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 its ID

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
tagsstring or null
cost_cpmnumber or null
external_identifierstring
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
curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/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,
    "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
  }'

Responses

Pixel Bundle has been updated successfully

Bodyapplication/json
dataobject(pixel_bundle)
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
  },
  "meta": {
    "status": "success"
  }
}

Get a Pixel Bundle

Request

Get a Pixel Bundle by its ID

Path
pixel_bundle_idintegerrequired

Numeric ID of the pixel bundle to get

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/pixel_bundles/{pixel_bundle_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Pixel Bundle GET

Bodyapplication/json
dataobject(pixel_bundle)
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
  },
  "meta": {
    "status": "success"
  }
}

Pixel Bundle Audit Log

Request

Get a list changes to this pixel bundle

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://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/pixel_bundles/{pixel_bundle_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"
  }
}

Campaign Plans

Campaign Plans

Operations

Strategy Plans

Strategy Plans

Operations

Bulk Update

Bulk Update

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

Timezones

Timezones

Operations

Strategy Groups

Strategy Groups

Operations

Strategy Day Parts

Strategy Day Parts

Operations

Strategy Deals

Strategy Deals

Operations

Strategy IP Addresses

Strategy IP Addresses

Operations

Strategy Concepts

Strategy Concepts

Operations

Targeting Segments

Targeting Segments

Operations

Strategy Target Values

Strategy Target Values

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

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