Strategy Plans
/
Post ephemeral strategy plan to run a forecast

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

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

List Strategy Plans

Request

Get a list of strategy plans

Query
organization_idinteger

Numeric ID of the organization to get campaign plans for

agency_idinteger

Numeric ID of the agency to get campaign plans for

advertiser_idinteger

Numeric ID of the advertiser to get campaign plans 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_plans?advertiser_id=0&agency_id=0&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 plan list that matches the parameter criteria

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

Create a strategy plan

Request

Create a strategy plan

Bodyapplication/json
namestringrequired
zone_namestringrequired
budgetobjectrequired
budget.​budgetnumber(float)

Must be a valid float between 1 and 10000000 USD or its equivalent in foreign currency. Required if max_bid is absent.

budget.​currency_codestring<= 3 charactersrequired

currency code for the budget

goalsobject
campaign_plan_idinteger(int32)
advertiser_idinteger(int32)
durationobject(duration_base)required
duration.​start_datestring or null(date-time)required

start_date can not be in the past

duration.​end_datestring or null(date-time)required

end_date must be between 1 and 30 days away from start_date

channelsArray of stringsrequired
Items Enum"display""video""audio""ctv"
creativesobjectrequired
creatives.​ad_expandableboolean or nullrequired
creatives.​ad_formatsArray of strings or nullrequired
creatives.​ad_sizesArray of strings or nullrequired
frequencyobject(frequency_base)required
frequency.​frequency_typestringrequired

if no-limit is selected, then frequency_amount is not required and frequency_interval must be not-applicable

Enum"no-limit""asap""even"
frequency.​frequency_amountinteger
frequency.​frequency_intervalstringrequired
Enum"not-applicable""hour""day""week""month"
targetingobject(targeting_base)required
targeting.​audienceobject
targeting.​contextualobject
targeting.​my_dataobject
targeting.​locationobject
targeting.​technologyobject
targeting.​day_partsArray of objects(day_part)
inventoryobject(inventory_base)required
Any of:
inventory.​supply_source_idsArray of integers
inventory.​run_on_all_exchangesboolean
inventory.​run_on_all_pmpboolean
inventory.​deal_idsArray of integers
inventory.​deal_group_idsArray of integers
inventory.​site_list_idsArray of integers
forecastobject or null(forecast_request)
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/strategy_plans \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "zone_name": "string",
    "budget": {
      "budget": 0.1,
      "currency_code": "str"
    },
    "goals": {
      "max_bid": 0.1
    },
    "campaign_plan_id": 0,
    "advertiser_id": 0,
    "duration": {
      "start_date": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24T14:15:22Z"
    },
    "channels": [
      "display"
    ],
    "creatives": {
      "ad_expandable": true,
      "ad_formats": [
        "string"
      ],
      "ad_sizes": [
        "string"
      ]
    },
    "frequency": {
      "frequency_type": "no-limit",
      "frequency_amount": 0,
      "frequency_interval": "not-applicable"
    },
    "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"
          ]
        }
      ]
    },
    "inventory": {
      "supply_source_ids": [
        0
      ],
      "run_on_all_exchanges": true,
      "run_on_all_pmp": true,
      "deal_ids": [
        0
      ],
      "deal_group_ids": [
        0
      ],
      "site_list_ids": [
        0
      ]
    },
    "forecast": {
      "forecast_date": "2050-01-01T16:00:00.000Z",
      "forecast_result": {
        "data": {
          "errors": null,
          "flags": null,
          "opps": 216000,
          "pricing": [
            {
              "impressions": 0,
              "price": "7.665749",
              "spend": "352816.151476",
              "uniques": 0
            }
          ],
          "uniques": 156270
        },
        "meta": {
          "status": "success"
        }
      }
    }
  }'

Responses

strategy plan response

Bodyapplication/json
dataobject(strategy plan response)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "campaign_plan_id": 0,
    "advertiser": { … },
    "name": "strategy plan test",
    "duration": { … },
    "zone_name": "America/Denver",
    "budget": { … },
    "goals": { … },
    "creatives": { … },
    "channels": [ … ],
    "frequency": { … },
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "forecast_date": "2019-08-24T14:15:22Z",
    "forecast_query": { … },
    "targeting": { … },
    "inventory": { … },
    "forecast": { … }
  },
  "meta": {
    "status": "success"
  }
}

Get Strategy Plan

Request

Get a strategy plan

Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to get

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

Responses

strategy plan response

Bodyapplication/json
dataobject(strategy plan response)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "campaign_plan_id": 0,
    "advertiser": { … },
    "name": "strategy plan test",
    "duration": { … },
    "zone_name": "America/Denver",
    "budget": { … },
    "goals": { … },
    "creatives": { … },
    "channels": [ … ],
    "frequency": { … },
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "forecast_date": "2019-08-24T14:15:22Z",
    "forecast_query": { … },
    "targeting": { … },
    "inventory": { … },
    "forecast": { … }
  },
  "meta": {
    "status": "success"
  }
}

Update a strategy plan

Request

Update a strategy plan

Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to update

Bodyapplication/json
namestringrequired
zone_namestringrequired
budgetobjectrequired
budget.​budgetnumber(float)

Must be a valid float between 1 and 10000000 USD or its equivalent in foreign currency. Required if max_bid is absent.

budget.​currency_codestring<= 3 charactersrequired

currency code for the budget

goalsobject
campaign_plan_idinteger(int32)
advertiser_idinteger(int32)
durationobject(duration_base)required
duration.​start_datestring or null(date-time)required

start_date can not be in the past

duration.​end_datestring or null(date-time)required

end_date must be between 1 and 30 days away from start_date

channelsArray of stringsrequired
Items Enum"display""video""audio""ctv"
creativesobjectrequired
creatives.​ad_expandableboolean or nullrequired
creatives.​ad_formatsArray of strings or nullrequired
creatives.​ad_sizesArray of strings or nullrequired
frequencyobject(frequency_base)required
frequency.​frequency_typestringrequired

if no-limit is selected, then frequency_amount is not required and frequency_interval must be not-applicable

Enum"no-limit""asap""even"
frequency.​frequency_amountinteger
frequency.​frequency_intervalstringrequired
Enum"not-applicable""hour""day""week""month"
targetingobject(targeting_base)required
targeting.​audienceobject
targeting.​contextualobject
targeting.​my_dataobject
targeting.​locationobject
targeting.​technologyobject
targeting.​day_partsArray of objects(day_part)
inventoryobject(inventory_base)required
Any of:
inventory.​supply_source_idsArray of integers
inventory.​run_on_all_exchangesboolean
inventory.​run_on_all_pmpboolean
inventory.​deal_idsArray of integers
inventory.​deal_group_idsArray of integers
inventory.​site_list_idsArray of integers
forecastobject or null(forecast_request)
curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/strategy_plans/{strategy_plan_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "zone_name": "string",
    "budget": {
      "budget": 0.1,
      "currency_code": "str"
    },
    "goals": {
      "max_bid": 0.1
    },
    "campaign_plan_id": 0,
    "advertiser_id": 0,
    "duration": {
      "start_date": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24T14:15:22Z"
    },
    "channels": [
      "display"
    ],
    "creatives": {
      "ad_expandable": true,
      "ad_formats": [
        "string"
      ],
      "ad_sizes": [
        "string"
      ]
    },
    "frequency": {
      "frequency_type": "no-limit",
      "frequency_amount": 0,
      "frequency_interval": "not-applicable"
    },
    "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"
          ]
        }
      ]
    },
    "inventory": {
      "supply_source_ids": [
        0
      ],
      "run_on_all_exchanges": true,
      "run_on_all_pmp": true,
      "deal_ids": [
        0
      ],
      "deal_group_ids": [
        0
      ],
      "site_list_ids": [
        0
      ]
    },
    "forecast": {
      "forecast_date": "2050-01-01T16:00:00.000Z",
      "forecast_result": {
        "data": {
          "errors": null,
          "flags": null,
          "opps": 216000,
          "pricing": [
            {
              "impressions": 0,
              "price": "7.665749",
              "spend": "352816.151476",
              "uniques": 0
            }
          ],
          "uniques": 156270
        },
        "meta": {
          "status": "success"
        }
      }
    }
  }'

Responses

strategy plan response

Bodyapplication/json
dataobject(strategy plan response)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "campaign_plan_id": 0,
    "advertiser": { … },
    "name": "strategy plan test",
    "duration": { … },
    "zone_name": "America/Denver",
    "budget": { … },
    "goals": { … },
    "creatives": { … },
    "channels": [ … ],
    "frequency": { … },
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "forecast_date": "2019-08-24T14:15:22Z",
    "forecast_query": { … },
    "targeting": { … },
    "inventory": { … },
    "forecast": { … }
  },
  "meta": {
    "status": "success"
  }
}

Delete strategy plans

Request

Delete a strategy plan

Path
strategy_plan_idintegerrequired

Array numeric IDs of the strategy_plan object to delete

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

Responses

deleted strategy plans response

Bodyapplication/json
dataobject or null
metaobject
Response
application/json
{
  "data": {},
  "meta": {
    "status": "success"
  }
}

Post ephemeral strategy plan to run a forecast

Request

Post a strategy plan object to run forcast without saving the strategy plan

Bodyapplication/json
namestringrequired
zone_namestringrequired
budgetobjectrequired
budget.​budgetnumber(float)

Must be a valid float between 1 and 10000000 USD or its equivalent in foreign currency. Required if max_bid is absent.

budget.​currency_codestring<= 3 charactersrequired

currency code for the budget

goalsobject
campaign_plan_idinteger(int32)
advertiser_idinteger(int32)
durationobject(duration_base)required
duration.​start_datestring or null(date-time)required

start_date can not be in the past

duration.​end_datestring or null(date-time)required

end_date must be between 1 and 30 days away from start_date

channelsArray of stringsrequired
Items Enum"display""video""audio""ctv"
creativesobjectrequired
creatives.​ad_expandableboolean or nullrequired
creatives.​ad_formatsArray of strings or nullrequired
creatives.​ad_sizesArray of strings or nullrequired
frequencyobject(frequency_base)required
frequency.​frequency_typestringrequired

if no-limit is selected, then frequency_amount is not required and frequency_interval must be not-applicable

Enum"no-limit""asap""even"
frequency.​frequency_amountinteger
frequency.​frequency_intervalstringrequired
Enum"not-applicable""hour""day""week""month"
targetingobject(targeting_base)required
targeting.​audienceobject
targeting.​contextualobject
targeting.​my_dataobject
targeting.​locationobject
targeting.​technologyobject
targeting.​day_partsArray of objects(day_part)
inventoryobject(inventory_base)required
Any of:
inventory.​supply_source_idsArray of integers
inventory.​run_on_all_exchangesboolean
inventory.​run_on_all_pmpboolean
inventory.​deal_idsArray of integers
inventory.​deal_group_idsArray of integers
inventory.​site_list_idsArray of integers
forecastobject or null(forecast_request)
curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/strategy_plans/forecast \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "zone_name": "string",
    "budget": {
      "budget": 0.1,
      "currency_code": "str"
    },
    "goals": {
      "max_bid": 0.1
    },
    "campaign_plan_id": 0,
    "advertiser_id": 0,
    "duration": {
      "start_date": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24T14:15:22Z"
    },
    "channels": [
      "display"
    ],
    "creatives": {
      "ad_expandable": true,
      "ad_formats": [
        "string"
      ],
      "ad_sizes": [
        "string"
      ]
    },
    "frequency": {
      "frequency_type": "no-limit",
      "frequency_amount": 0,
      "frequency_interval": "not-applicable"
    },
    "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"
          ]
        }
      ]
    },
    "inventory": {
      "supply_source_ids": [
        0
      ],
      "run_on_all_exchanges": true,
      "run_on_all_pmp": true,
      "deal_ids": [
        0
      ],
      "deal_group_ids": [
        0
      ],
      "site_list_ids": [
        0
      ]
    },
    "forecast": {
      "forecast_date": "2050-01-01T16:00:00.000Z",
      "forecast_result": {
        "data": {
          "errors": null,
          "flags": null,
          "opps": 216000,
          "pricing": [
            {
              "impressions": 0,
              "price": "7.665749",
              "spend": "352816.151476",
              "uniques": 0
            }
          ],
          "uniques": 156270
        },
        "meta": {
          "status": "success"
        }
      }
    }
  }'

Responses

strategy plan response

Bodyapplication/json
dataobject(strategy plan response)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "campaign_plan_id": 0,
    "advertiser": { … },
    "name": "strategy plan test",
    "duration": { … },
    "zone_name": "America/Denver",
    "budget": { … },
    "goals": { … },
    "creatives": { … },
    "channels": [ … ],
    "frequency": { … },
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "forecast_date": "2019-08-24T14:15:22Z",
    "forecast_query": { … },
    "targeting": { … },
    "inventory": { … },
    "forecast": { … }
  },
  "meta": {
    "status": "success"
  }
}

Run and update forecast for given strategy_plan_id

Request

Run and update forecast for given strategy_plan_id

Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to run a forecast

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/strategy_plans/{strategy_plan_id}/forecast' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

strategy plan response

Bodyapplication/json
dataobject(strategy plan response)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "campaign_plan_id": 0,
    "advertiser": { … },
    "name": "strategy plan test",
    "duration": { … },
    "zone_name": "America/Denver",
    "budget": { … },
    "goals": { … },
    "creatives": { … },
    "channels": [ … ],
    "frequency": { … },
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "forecast_date": "2019-08-24T14:15:22Z",
    "forecast_query": { … },
    "targeting": { … },
    "inventory": { … },
    "forecast": { … }
  },
  "meta": {
    "status": "success"
  }
}

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