Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
Languages
Servers
Mock server
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/

Organizations

Organizations

Operations

List Organizations

Request

Get a list of organizations

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.
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/organizations?full=*&page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of organizations

Bodyapplication/json
One of:
dataArray of objects
metaobject(pagination metadata)
Response
application/json
{ "data": [ {}, {}, {} ], "meta": { "count": 3, "total_count": 100, "offset": 0, "status": "success" } }

Create an Organization

Request

Create an organization

Bodyapplication/jsonrequired
namestring[ 1 .. 64 ] charactersrequired

The name of the organization with whom the contract is held. This can be an agency holding company, agency, advertiser, network, or other media or data buying entity.

org_typeArray of stringsunique

The org_type field is an array that specifies the type of organization.

Items Enum"buyer""partner"
statusbooleanrequired
websitestring or null<= 512 characters
facebookstring or null<= 512 characters
linkedinstring or null<= 512 characters
twitterstring or null<= 512 characters
allow_x_agency_pixelsboolean

This field enables the Data Co-op functionality across all the Advertisers under this organization. Cross-Advertiser Pixel Targeting allows Advertisers to target other Advertiser Event Pixels within their Agency and any other similarly enabled Agency under the same Organization.

allow_byo_priceboolean
opt_out_connected_idboolean
opt_out_connected_id_mathidboolean
override_suspicious_traffic_filterboolean

Set flag to 'on’ to be able to override default org wide suspicious traffic filter level.

restrict_targeting_to_same_device_idboolean
restrict_targeting_to_deterministic_idboolean
suspicious_traffic_filter_levelinteger[ 0 .. 100 ]

Specify an organization-wide level of suspicious traffic filtering to use. See the Knowledge Base for additional details about this feature. This setting will only take affect if the organization's override_suspicious_traffic_filter property is set to 'on'. If override_suspicious_traffic_filter is enabled and suspicious_traffic_filter_level is set to 0, all fraud and suspicious traffic will be filtered.

use_ads_txtboolean
use_evidon_opt_outboolean or null

Set flag to 'on’ to show an opt out button on the organization's ads (additional CPM fee will apply when on).

eligible_for_data_sharingboolean
holding_org_idinteger or null
service_provider_ccpaboolean
mm_contact_namestring<= 64 charactersrequired

This is the name of the primary internal MediaMath contact of the Organization.

adx_seat_account_idinteger>= 1required

Passed to ADX upon creative registration so ADX knows which seat we're registering under.

connected_id_typestringrequired
Value"DETERMINISTIC_FIRST"
contact_namestring<= 64 charactersrequired

This is the primary contact at the organization regarding contract issues.

address_1string<= 256 charactersrequired

The primary address line, typically includes street address and number.

address_2string or null<= 256 characters

The secondary address line, used for additional information such as apartment, suite, or unit number.

citystring<= 32 charactersrequired

The city of the address.

statestring<= 2 charactersrequired

The state of the address, represented as a 2-character code.

zipstring<= 10 charactersrequired

The postal or ZIP code for the address.

countrystring<= 2 charactersrequired

The country of the address, represented as a 2-character ISO country code.

phonestring<= 24 charactersrequired

The phone number associated with the address, including country code if applicable.

currency_codestring<= 3 charactersrequired

Currency code for the campaign budget and spend, as well as billing.

billing_country_codestringrequired

Country code that is used for billing purposes.

dmp_enabledstringrequired
Enum"enabled""disabled"
tag_rulesetstring or null<= 64 characters
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "org_type": [
      "buyer"
    ],
    "status": true,
    "website": "string",
    "facebook": "string",
    "linkedin": "string",
    "twitter": "string",
    "allow_x_agency_pixels": true,
    "allow_byo_price": true,
    "opt_out_connected_id": true,
    "opt_out_connected_id_mathid": true,
    "override_suspicious_traffic_filter": true,
    "restrict_targeting_to_same_device_id": true,
    "restrict_targeting_to_deterministic_id": true,
    "suspicious_traffic_filter_level": 100,
    "use_ads_txt": true,
    "use_evidon_opt_out": true,
    "eligible_for_data_sharing": true,
    "holding_org_id": 0,
    "service_provider_ccpa": true,
    "mm_contact_name": "string",
    "adx_seat_account_id": 1,
    "connected_id_type": "DETERMINISTIC_FIRST",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "st",
    "zip": "string",
    "country": "st",
    "phone": "string",
    "currency_code": "str",
    "billing_country_code": "string",
    "dmp_enabled": "enabled",
    "tag_ruleset": "string"
  }'

Responses

Created

Bodyapplication/json
dataobject(organization)
metaobject
Response
application/json
{ "data": { "name": "string", "org_type": [], "status": true, "website": "string", "facebook": "string", "linkedin": "string", "twitter": "string", "allow_x_agency_pixels": true, "allow_byo_price": true, "opt_out_connected_id": true, "opt_out_connected_id_mathid": true, "override_suspicious_traffic_filter": true, "restrict_targeting_to_same_device_id": true, "restrict_targeting_to_deterministic_id": true, "suspicious_traffic_filter_level": 100, "use_ads_txt": true, "use_evidon_opt_out": true, "eligible_for_data_sharing": true, "holding_org_id": 0, "service_provider_ccpa": true, "mm_contact_name": "string", "adx_seat_account_id": 1, "connected_id_type": "DETERMINISTIC_FIRST", "contact_name": "string", "address_1": "string", "address_2": "string", "city": "string", "state": "st", "zip": "string", "country": "st", "phone": "string", "currency_code": "str", "billing_country_code": "string", "dmp_enabled": "enabled", "tag_ruleset": "string", "id": 0, "created_on": "2019-08-24T14:15:22Z", "entity_type": "string", "terminated": true, "updated_on": "2019-08-24T14:15:22Z", "version": 0 }, "meta": { "status": "success" } }

Get an Organization

Request

Get an existing organization

Path
organization_idintegerrequired

Numeric ID of the organization

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

Responses

OK

Bodyapplication/json
dataobject(organization)
metaobject
Response
application/json
{ "data": { "name": "string", "org_type": [], "status": true, "website": "string", "facebook": "string", "linkedin": "string", "twitter": "string", "allow_x_agency_pixels": true, "allow_byo_price": true, "opt_out_connected_id": true, "opt_out_connected_id_mathid": true, "override_suspicious_traffic_filter": true, "restrict_targeting_to_same_device_id": true, "restrict_targeting_to_deterministic_id": true, "suspicious_traffic_filter_level": 100, "use_ads_txt": true, "use_evidon_opt_out": true, "eligible_for_data_sharing": true, "holding_org_id": 0, "service_provider_ccpa": true, "mm_contact_name": "string", "adx_seat_account_id": 1, "connected_id_type": "DETERMINISTIC_FIRST", "contact_name": "string", "address_1": "string", "address_2": "string", "city": "string", "state": "st", "zip": "string", "country": "st", "phone": "string", "currency_code": "str", "billing_country_code": "string", "dmp_enabled": "enabled", "tag_ruleset": "string", "id": 0, "created_on": "2019-08-24T14:15:22Z", "entity_type": "string", "terminated": true, "updated_on": "2019-08-24T14:15:22Z", "version": 0 }, "meta": { "status": "success" } }

Update an Organization

Request

Update an existing organization

Path
organization_idintegerrequired

Numeric ID of the organization to update

Bodyapplication/jsonrequired
namestring[ 1 .. 64 ] charactersrequired
org_typeArray of stringsunique
Items Enum"buyer""partner"
statusbooleanrequired
websitestring or null<= 512 characters
facebookstring or null<= 512 characters
linkedinstring or null<= 512 characters
twitterstring or null<= 512 characters
allow_x_agency_pixelsboolean
allow_byo_priceboolean
opt_out_connected_idboolean
opt_out_connected_id_mathidboolean
override_suspicious_traffic_filterboolean
restrict_targeting_to_same_device_idboolean
restrict_targeting_to_deterministic_idboolean
suspicious_traffic_filter_levelinteger[ 0 .. 100 ]
use_ads_txtboolean
use_evidon_opt_outboolean or null
eligible_for_data_sharingboolean
holding_org_idinteger or null
service_provider_ccpaboolean
mm_contact_namestring<= 64 charactersrequired
adx_seat_account_idinteger>= 1required
connected_id_typestringrequired
Value"DETERMINISTIC_FIRST"
contact_namestring<= 64 charactersrequired
address_1string<= 256 charactersrequired
address_2string or null<= 256 characters
citystring<= 32 charactersrequired
statestring<= 2 charactersrequired
zipstring<= 10 charactersrequired
countrystring<= 2 charactersrequired
phonestring<= 24 charactersrequired
currency_codestring<= 3 charactersrequired
billing_country_codestringrequired
dmp_enabledstringrequired
Enum"enabled""disabled"
terminatedboolean
versioninteger
tag_rulesetstring or null<= 64 characters
curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations/{organization_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "org_type": [
      "buyer"
    ],
    "status": true,
    "website": "string",
    "facebook": "string",
    "linkedin": "string",
    "twitter": "string",
    "allow_x_agency_pixels": true,
    "allow_byo_price": true,
    "opt_out_connected_id": true,
    "opt_out_connected_id_mathid": true,
    "override_suspicious_traffic_filter": true,
    "restrict_targeting_to_same_device_id": true,
    "restrict_targeting_to_deterministic_id": true,
    "suspicious_traffic_filter_level": 100,
    "use_ads_txt": true,
    "use_evidon_opt_out": true,
    "eligible_for_data_sharing": true,
    "holding_org_id": 0,
    "service_provider_ccpa": true,
    "mm_contact_name": "string",
    "adx_seat_account_id": 1,
    "connected_id_type": "DETERMINISTIC_FIRST",
    "contact_name": "string",
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "state": "st",
    "zip": "string",
    "country": "st",
    "phone": "string",
    "currency_code": "str",
    "billing_country_code": "string",
    "dmp_enabled": "enabled",
    "terminated": true,
    "version": 0,
    "tag_ruleset": "string"
  }'

Responses

Updated

Bodyapplication/json
dataobject(organization)
metaobject
Response
application/json
{ "data": { "name": "string", "org_type": [], "status": true, "website": "string", "facebook": "string", "linkedin": "string", "twitter": "string", "allow_x_agency_pixels": true, "allow_byo_price": true, "opt_out_connected_id": true, "opt_out_connected_id_mathid": true, "override_suspicious_traffic_filter": true, "restrict_targeting_to_same_device_id": true, "restrict_targeting_to_deterministic_id": true, "suspicious_traffic_filter_level": 100, "use_ads_txt": true, "use_evidon_opt_out": true, "eligible_for_data_sharing": true, "holding_org_id": 0, "service_provider_ccpa": true, "mm_contact_name": "string", "adx_seat_account_id": 1, "connected_id_type": "DETERMINISTIC_FIRST", "contact_name": "string", "address_1": "string", "address_2": "string", "city": "string", "state": "st", "zip": "string", "country": "st", "phone": "string", "currency_code": "str", "billing_country_code": "string", "dmp_enabled": "enabled", "tag_ruleset": "string", "id": 0, "created_on": "2019-08-24T14:15:22Z", "entity_type": "string", "terminated": true, "updated_on": "2019-08-24T14:15:22Z", "version": 0 }, "meta": { "status": "success" } }

Organization Audit Log

Request

Get a list of changes to this organization

Path
organization_idintegerrequired

Numeric ID of the organization

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/organizations/{organization_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" } }

Bulk Organization Audit Log

Request

Get a list of changes to these organizations

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/json
idArray of integersnon-emptyrequired
curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/audit_log/organizations?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": [
      0
    ]
  }'

Responses

list of changes to a group 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" } }

List User Permissions for an Organization

Request

List User Permissions for an Organization

Path
organization_idintegerrequired

Numeric ID of the organization

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

Responses

OK

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

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

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