Strategy Templates

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
Mock server
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/

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

Create Strategy Template

Request

Create a strategy template

Bodyapplication/json
organization_idinteger or null(int32)
agency_idinteger or null(int32)
advertiser_idinteger or null(int32)
globalboolean or null
namestring[ 1 .. 256 ] charactersrequired
descriptionstring[ 1 .. 256 ] charactersrequired
templatestringrequired
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/strategy_templates \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "global": true,
    "name": "valid strategy template (Global)",
    "description": "this is an example of valid strategy template  at Global level",
    "template": "key: value"
  }'

Responses

Created

Bodyapplication/json
organization_idinteger
agency_idinteger
advertiser_idinteger
globalboolean
namestring
descriptionstring
templatestring
created_onstring or null(date-time)read-only
updated_onstring or null(date-time)read-only
Response
application/json
{
  "organization_id": 0,
  "agency_id": 0,
  "advertiser_id": 0,
  "global": true,
  "name": "string",
  "description": "string",
  "template": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}

List Strategy Templates

Request

Get a list of strategy templates

Query
globalboolean

Boolean value to get global strategy templates

organization_idinteger

Numeric ID of the organization to get strategy templates for

agency_idinteger

Numeric ID of the agency to get strategy templates for

advertiser_idinteger

Numeric ID of the advertiser to get strategy templates for

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
sort_orderstring

Sorting order for the sort_by parameter for the result list

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.
curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/strategy_templates?advertiser_id=0&agency_id=0&global=true&organization_id=0&page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name&sort_order=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

strategy template list that matches the parameter criteria

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

Update a Strategy Template

Request

Update a strategy template

Path
strategy_template_idintegerrequired

Numeric ID of the strategy_template object

Bodyapplication/json
organization_idinteger or null(int32)
agency_idinteger or null(int32)
advertiser_idinteger or null(int32)
globalboolean or null
namestring[ 1 .. 256 ] charactersrequired
descriptionstring[ 1 .. 256 ] charactersrequired
templatestringrequired
curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/strategy_templates/{strategy_template_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "global": true,
    "name": "valid strategy template (Global)",
    "description": "this is an example of valid strategy template  at Global level",
    "template": "key: value"
  }'

Responses

Updated

Bodyapplication/json
organization_idinteger
agency_idinteger
advertiser_idinteger
globalboolean
namestring
descriptionstring
templatestring
created_onstring(date-time)read-only
updated_onstring(date-time)read-only
Response
application/json
{
  "organization_id": 0,
  "agency_id": 0,
  "advertiser_id": 0,
  "global": true,
  "name": "string",
  "description": "string",
  "template": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}

Update a Strategy Template

Request

Get a strategy template

Path
strategy_template_idintegerrequired

Numeric ID of the strategy_template

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

Responses

Updated

Bodyapplication/json
organization_idinteger
agency_idinteger
advertiser_idinteger
globalboolean
namestring
descriptionstring
templatestring
created_onstring(date-time)read-only
updated_onstring(date-time)read-only
Response
application/json
{
  "organization_id": 0,
  "agency_id": 0,
  "advertiser_id": 0,
  "global": true,
  "name": "string",
  "description": "string",
  "template": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}

Delete a Strategy Template

Request

Delete a strategy template

Path
strategy_template_idintegerrequired

Numeric ID of the strategy_template

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

Responses

OK

Response
No content

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