Skip to content

Campaigns API (xx.xx.xx)

MediaMath Platform API

Download OpenAPI description
Languages
Servers
Live Server

https://api.mediamath.com/api/v3.0/

Operations
Operations
Operations
Operations

Campaigns Budget Flights

Campaigns Budget Flights

Operations
Operations
Operations

Strategy Parameters

Strategy Parameters

Operations

Strategy Templates

Strategy Templates

Operations

New Strategy Plans

New Strategy Plans

Operations
Operations

Request

Delete a target by ID

Security
Auth0
Path
target_idintegerrequired

Numeric ID of the target to delete

curl -i -X DELETE \
  'https://api.mediamath.com/api/v3.0/targets/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Target deleted response

Bodyapplication/json
metaobject(single_metadata)
Response
application/json
{ "meta": { "status": "success" } }

Request

Get a list of target paths

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.

  • 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.
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/target-path?page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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

Request

Add and view targeting

Security
Auth0
Bodyapplication/json
strategy_idArray of integersrequired
targetingobject(targeting_base)
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/targeting \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "strategy_id": [
      0
    ],
    "targeting": {
      "audience": {
        "include": [
          {
            "operator": "AND",
            "audience_segment_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "operator": "AND",
            "audience_segment_ids": [
              0
            ]
          }
        ]
      },
      "contextual": {
        "include": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ]
      },
      "my_data": {
        "include": {
          "pixel_bundle_ids": [
            0
          ],
          "operator": "AND"
        },
        "exclude": {
          "pixel_bundle_ids": [
            0
          ]
        }
      },
      "location": {
        "include": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ]
      },
      "technology": {
        "include": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ]
      },
      "day_parts": [
        {
          "user_time": true,
          "start_hour": 1,
          "end_hour": 5,
          "days": [
            "M",
            "T",
            "W",
            "S",
            "U"
          ]
        }
      ]
    }
  }'

Responses

Add and view response

Bodyapplication/json
dataobject
metaobjectrequired
meta.​statusstringnon-emptyrequired
meta.​countnumberrequired
errorsArray of objects or null
Response
application/json
{ "data": { "location": [] }, "meta": { "status": "string", "count": 0 }, "errors": [ null ] }

Targeting Attachments

TargetingAttachments

Operations

Targeting Segments

Targeting Segments

Operations

Targeting Segment Objectives

Targeting Segment Objectives

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Enterprise Controls

Enterprise Controls

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations