Get a Strategy Template

Organizations

Operations

Agencies

Operations

Advertisers

Operations

Campaigns

Operations

Campaigns Budget Flights

Operations

Campaign Plans

Operations

Strategies

Operations

Strategy Parameters

Operations

Strategy Templates

Operations

Create a Strategy Template

Request

Create a strategy template

Security

Auth0

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://api.mediamath.com/api/v3.0/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

Strategy created response

Bodyapplication/json

dataobject

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "organization_id": 0,
    "agency_id": 0,
    "advertiser_id": 0,
    "global": true,
    "name": "string",
    "description": "string",
    "template": {},
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}

List Strategy Templates

Request

Get a list of strategy templates

Security

Auth0

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

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/strategy_templates?global=true&organization_id=0&agency_id=0&advertiser_id=0&page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List strategy templates response

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 by ID

Security

Auth0

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://api.mediamath.com/api/v3.0/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

Strategy updated response

Bodyapplication/json

dataobject

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "organization_id": 0,
    "agency_id": 0,
    "advertiser_id": 0,
    "global": true,
    "name": "string",
    "description": "string",
    "template": {},
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}