Skip to content
/
Get Entity Group Controls...

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

List Entity Groups

Request

Get a list of entity groups

Security
Auth0
curl -i -X GET \
  https://api.mediamath.com/api/v3.0/entity_groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List entity groups response

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

Get an Entity Group

Request

Get an entity group by ID

Security
Auth0
Path
entity_group_idintegerrequired
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/entity_groups/{entity_group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Entity group response

Bodyapplication/json
dataobject(entity_group)
metaobject(pagination metadata)
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "name": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "organizations": [ … ],
    "agencies": [ … ],
    "advertisers": [ … ]
  },
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Get Entity Group Controls by Entity Type

Request

Get controls of entity group by entity type

Security
Auth0
Path
entity_group_idintegerrequired
entity_typestringrequired
Enum"agencies""advertisers""campaigns""strategies""deals""atomic_creatives""strategy_supply_sources"
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/entity_groups/{entity_group_id}/controls/{entity_type}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Entity group controls by entity type response

Bodyapplication/json
dataArray of control_integer (object) or control_integer_array (object) or control_decimal (object) or control_decimal_array (object) or control_string (object) or control_string_array (object) or control_boolean (object)(enterprise_control)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Entity Group Audit Log

Request

Get a list changes to this entity group

Security
Auth0
Path
entity_group_idintegerrequired

Numeric ID of the entity group

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/entity_groups/{entity_group_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"
  }
}

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