Skip to content
/
Download Information for...

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

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

List Site Lists

Request

Get a list of site lists. Site lists can be sorted and queried by fields:

  • id,
  • version,
  • status,
  • organization_id,
  • name,
  • restriction,
  • filename,
  • content_updated_on,
  • sites_count,
  • created_on,
  • updated_on.
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. Supported operators:

  • == - numeric equality or case-sensitive string identity,
  • ==(1,2,3) - IN query (only works for integers),
  • != - numeric inequality or case-sensitive string non-identity,
  • =: - case-insensitive match, allows substring using * wildcards,
  • < - less than,
  • <= - less than or equal to,
  • > - greater than,
  • >= - greater than or equal to. Examples:
  • 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) to find specific entities by ID.
  • q=created_on>1999-02-02 or q=created_on>1999-02-02T00:00:00Z to find entities created later than date.
  • q=id>5&status==true to find all active entities with id greater than 5.
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/site_lists?page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string&full=*' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List site lists 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"
  }
}

Get Site List

Request

Get a site list by ID

Security
Auth0
Path
site_list_idintegerrequired

Numeric ID of the site list to get

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

Responses

Site list response

Bodyapplication/json
dataobject(site_list_full)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "id": 126,
    "version": 2,
    "status": true,
    "organization_id": 16,
    "name": "string",
    "restriction": "INCLUDE",
    "filename": "test_site_list.csv",
    "content_updated_on": "2019-08-24T14:15:22Z",
    "sites_count": 100,
    "sites_count_domain": 1,
    "sites_count_app": 2,
    "sites_count_primary_seller_id": 3,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}

Upload New Site Lists

Request

Upload new site lists

Security
Auth0
Bodymultipart/form-datarequired
filestring(binary)required

The file to be uploaded (e.g., comma_sep.txt).

organization_idstringrequired

The ID of the organization. Its a string because form upload

namestringrequired

The name of the site list being uploaded.

Example: "Test List"
restrictionstring
Default "INCLUDE"
Enum"INCLUDE""EXCLUDE"
statusstring
Enum"true""false""0""1"
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/site_lists/upload \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F organization_id=string \
  -F 'name=Test List' \
  -F restriction=INCLUDE \
  -F status=true

Responses

Site list response

Bodyapplication/json
dataobject(site_list_full)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "id": 126,
    "version": 2,
    "status": true,
    "organization_id": 16,
    "name": "string",
    "restriction": "INCLUDE",
    "filename": "test_site_list.csv",
    "content_updated_on": "2019-08-24T14:15:22Z",
    "sites_count": 100,
    "sites_count_domain": 1,
    "sites_count_app": 2,
    "sites_count_primary_seller_id": 3,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}

Upload Updated Site Lists

Request

Upload updated site lists

Security
Auth0
Path
site_list_idintegerrequired

Numeric ID of the site list to get site list assignments

Bodymultipart/form-data
filestring(binary)

The file to be uploaded (e.g., comma_sep.txt).

organization_idstring

The ID of the organization. Its a string because form upload

namestring

The name of the site list being uploaded.

Example: "Test List"
restrictionstring
Enum"INCLUDE""EXCLUDE"
statusstring
Enum"true""false""0""1"
versioninteger
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/site_lists/{site_list_id}/upload' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=string \
  -F organization_id=string \
  -F 'name=Test List' \
  -F restriction=INCLUDE \
  -F status=true \
  -F version=0

Responses

Site list response

Bodyapplication/json
dataobject(site_list_full)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "id": 126,
    "version": 2,
    "status": true,
    "organization_id": 16,
    "name": "string",
    "restriction": "INCLUDE",
    "filename": "test_site_list.csv",
    "content_updated_on": "2019-08-24T14:15:22Z",
    "sites_count": 100,
    "sites_count_domain": 1,
    "sites_count_app": 2,
    "sites_count_primary_seller_id": 3,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}

Download Information for a Site List

Request

CSV download of site information for a site list

Security
Auth0
Path
site_list_idintegerrequired

Numeric ID of the site list to get site list assignments

Query
target_typestring

Filter the sites download by a target type

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/site_lists/{site_list_id}/download.csv?target_type=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful CSV download.

Headers
Content-Dispositionstring

Indicates that the response should be handled as a file attachment.

Bodytext/csv
string(binary)
Response
No content

List Site List Assignments

Request

Get a list of assignments for a site list

Security
Auth0
Path
site_list_idintegerrequired

Numeric ID of the site list to get site list assignments

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. Supported operators:

  • == - numeric equality or case-sensitive string identity,
  • ==(1,2,3) - IN query (only works for integers),
  • != - numeric inequality or case-sensitive string non-identity,
  • =: - case-insensitive match, allows substring using * wildcards,
  • < - less than,
  • <= - less than or equal to,
  • > - greater than,
  • >= - greater than or equal to. Examples:
  • 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) to find specific entities by ID.
  • q=created_on>1999-02-02 or q=created_on>1999-02-02T00:00:00Z to find entities created later than date.
  • q=id>5&status==true to find all active entities with id greater than 5.
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/site_lists/{site_list_id}/assignments?page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string&full=*' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List assignments response. Can be queried and sorted by:

  • id,
  • site_list_id,
  • entity_id,
  • associated_campaign_id,
  • collection,
  • name.
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"
  }
}

Timezones

Timezones

Operations

Verticals

Verticals

Operations

Supply Sources

Supply Sources

Operations

Ad Servers

Ad Servers

Operations

Segment Groups

Segment Groups

Operations