Skip to content

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

List User Permissions

Request

Get a list of user permissions

Security
Auth0
Path
user_idintegerrequired

User ID

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
organization_idArray of integers

Numeric ID of the user

agency_idArray of integers

Numeric ID of the agency

advertiser_idArray of integers

Numeric ID of the advertiser

campaign_idArray of integers

Numeric ID of the campaign

strategy_idArray of integers

Numeric ID of the strategy

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/permissions/{user_id}?page_limit=100&page_offset=0&organization_id=0&agency_id=0&advertiser_id=0&campaign_id=0&strategy_id=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List user permissions response

Bodyapplication/json
dataobject(permission_list)
metaobject
Response
application/json
{
  "data": {
    "organizations": [ … ],
    "agencies": [ … ],
    "advertisers": [ … ],
    "campaigns": [ … ],
    "strategies": [ … ]
  },
  "meta": {
    "status": "success"
  }
}

List User Permissions for Entities

Request

Get a list of user permissions for requested entities

Security
Auth0
Path
user_idintegerrequired

User ID

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
Bodyapplication/jsonrequired
organizationsArray of integers
agenciesArray of integers
advertisersArray of integers
campaignsArray of integers
strategiesArray of integers
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/permissions/{user_id}?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organizations": [
      0
    ],
    "agencies": [
      0
    ],
    "advertisers": [
      0
    ],
    "campaigns": [
      0
    ],
    "strategies": [
      0
    ]
  }'

Responses

List user permissions response

Bodyapplication/json
dataobject(permission_list)
metaobject
Response
application/json
{
  "data": {
    "organizations": [ … ],
    "agencies": [ … ],
    "advertisers": [ … ],
    "campaigns": [ … ],
    "strategies": [ … ]
  },
  "meta": {
    "status": "success"
  }
}

List User Permissions for All Organizations

Request

Get a list of user permissions for organizations

Security
Auth0
Path
user_idintegerrequired

User ID

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/permissions/{user_id}/organizations?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List user permissions response

Bodyapplication/json
dataArray of objects(permission_organization)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

List User Permissions for All Agencies

Request

Get a list of user permissions for agencies

Security
Auth0
Path
user_idintegerrequired

User ID

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/permissions/{user_id}/agencies?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List user permissions response

Bodyapplication/json
dataArray of objects(permission_agency)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

List User Permissions for All Advertisers

Request

Get a list of user permissions for advertisers

Security
Auth0
Path
user_idintegerrequired

User ID

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/permissions/{user_id}/advertisers?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List user permissions response

Bodyapplication/json
dataArray of objects(permission_advertiser)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

List User Permissions for All Campaigns

Request

Get a list of user permissions for campaigns

Security
Auth0
Path
user_idintegerrequired

User ID

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/permissions/{user_id}/campaigns?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List user permissions response

Bodyapplication/json
dataArray of objects(permission_campaign)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

List User Permissions for All Strategies

Request

Get a list of user permissions for strategies

Security
Auth0
Path
user_idintegerrequired

User ID

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/permissions/{user_id}/strategies?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List user permissions response

Bodyapplication/json
dataArray of objects(permission_strategy)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

List User Permissions (V2 Format)

Request

Get a list of user permissions in V2 format

Security
Auth0
Path
user_idintegerrequired

User ID

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

Responses

List user permissions response

Bodyapplication/json
dataobject(permission_v2_object)
metaobject
Response
application/json
{
  "data": {
    "flags": { … },
    "entities": { … }
  },
  "meta": {
    "status": "success"
  }
}

List User Permissions for Entities (V2 Format)

Request

Get a list of user permissions for requested entities in V2 format

Security
Auth0
Path
user_idintegerrequired

User ID

Bodyapplication/jsonrequired
organizationsArray of integers
agenciesArray of integers
advertisersArray of integers
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/permissions/{user_id}/v2format' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organizations": [
      0
    ],
    "agencies": [
      0
    ],
    "advertisers": [
      0
    ]
  }'

Responses

List user permissions response

Bodyapplication/json
dataobject(permission_v2_object)
metaobject
Response
application/json
{
  "data": {
    "flags": { … },
    "entities": { … }
  },
  "meta": {
    "status": "success"
  }
}

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