Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
Languages
Servers

https://apidocs.mediamath.com/

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

Campaign Plans

Campaign Plans

Operations

Strategy Plans

Strategy Plans

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

Contracts

Contracts

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

Bulk Concepts

Operations

Verticals

Operations

Audience Vendors

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

Contract

Operations

Segment Groups

Operations

Create Segment Group

Request

Create a new Segment Group

Bodyapplication/json
namestring[ 1 .. 256 ] charactersrequired
typestringrequired
Value"CONTEXTUAL"
organization_idinteger(int32)required
statusbooleanrequired
segment_subgroupArray of objectsrequired
segment_subgroup[].​segment_operatorstringrequired
Enum"AND""OR"
segment_subgroup[].​segment_membersArray of integers(int32)required
curl -i -X POST \
  https://apidocs.mediamath.com/segment_groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "type": "CONTEXTUAL",
    "organization_id": 0,
    "status": true,
    "segment_subgroup": [
      {
        "segment_operator": "AND",
        "segment_members": [
          0
        ]
      }
    ]
  }'

Responses

audience group response

Bodyapplication/json
dataobject
Response
application/json
{ "data": { "name": "My Audience Group", "type": "CONTEXTUAL", "organization_id": 1234, "status": true, "segment_subgroup": [] } }

List Segment Groups

Request

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.
  • q=id==(1,2,3) find specific entities by ID.
extendedboolean

Get extended properties in response

curl -i -X GET \
  'https://apidocs.mediamath.com/segment_groups?extended=true&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

audience group collection response

Bodyapplication/json
dataArray of objects
Response
application/json
{ "data": [ {} ] }

Update Segment Group

Request

Update an existing Segment Group

Path
segment_group_idintegerrequired

Numeric ID of the segment group to update

Bodyapplication/json
namestring[ 1 .. 256 ] characters
typestring
Value"CONTEXTUAL"
organization_idinteger(int32)
statusboolean
segment_subgroupArray of objects
curl -i -X POST \
  'https://apidocs.mediamath.com/segment_groups/{segment_group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "type": "CONTEXTUAL",
    "organization_id": 0,
    "status": true,
    "segment_subgroup": [
      {
        "segment_operator": "AND",
        "segment_members": [
          0
        ]
      }
    ]
  }'

Responses

audience group response

Bodyapplication/json
dataobject
Response
application/json
{ "data": { "name": "My Audience Group", "type": "CONTEXTUAL", "organization_id": 1234, "status": true, "segment_subgroup": [] } }

Get Segment Group

Request

Get details of a specific Segment Group

Path
segment_group_idintegerrequired

Numeric ID of the segment group to retrieve

Query
extendedboolean

Get extended properties in response

curl -i -X GET \
  'https://apidocs.mediamath.com/segment_groups/{segment_group_id}?extended=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

audience group response

Bodyapplication/json
dataobject
Response
application/json
{ "data": { "name": "My Audience Group", "type": "CONTEXTUAL", "organization_id": 1234, "status": true, "segment_subgroup": [] } }

Get Segment Group Assignments

Request

Get all assignments for a specific Segment Group

Path
segment_group_idintegerrequired

Numeric ID of the segment group to retrieve assignments for

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

Responses

audience group assignments response

Bodyapplication/json
dataArray of objects
Response
application/json
{ "data": [ {} ] }

Pixel Providers

Operations