Skip to content
Campaign Plans
/
List Campaign Plans

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
Live Server

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

Organizations

Organizations

Operations

Agencies

Agencies

Operations

Advertisers

Advertisers

Operations

Campaigns

Campaigns

Operations

Campaigns Budget Flights

Campaigns Budget Flights

Operations

Campaign Plans

Campaign Plans

Operations

List Campaign Plans

Request

Get a list of campaign plans

Security
Auth0
curl -i -X GET \
  https://api.mediamath.com/api/v3.0/campaign_plans \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List campaign plans response

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

Create Campaign Plan

Request

Create a campaign plan

Security
Auth0
Bodyapplication/json
namestring[ 1 .. 256 ] charactersrequired
advertiser_idinteger(int32)required
durationobjectrequired
duration.​start_datestring(date-time)required
duration.​end_datestring(date-time)required
budgetobjectrequired
budget.​total_budgetnumber(float)[ 1 .. 99999999999999.98 ]required
budget.​currency_codestring<= 3 charactersrequired
zone_namestringrequired
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/campaign_plans \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "advertiser_id": 190,
    "name": "valid campaign plan",
    "duration": {
      "start_date": "2050-01-01T10:00:00Z",
      "end_date": "2050-01-10T23:59:00Z"
    },
    "budget": {
      "currency_code": "USD",
      "total_budget": 100
    },
    "zone_name": "America/New_York"
  }'

Responses

Campaign plan created response

Bodyapplication/json
dataobject(campaign_plan)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "version": 0,
    "id": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "name": "string",
    "duration": { … },
    "budget": { … },
    "zone_name": "string"
  },
  "meta": {
    "status": "success"
  }
}

Get a Campaign Plan

Request

Get a campaign plan by ID

Security
Auth0
Path
campaign_plan_idintegerrequired

Numeric ID of the campaign plan

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/campaign_plans/{campaign_plan_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Campaign plan response

Bodyapplication/json
dataobject(campaign_plan)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "version": 0,
    "id": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "name": "string",
    "duration": { … },
    "budget": { … },
    "zone_name": "string"
  },
  "meta": {
    "status": "success"
  }
}

Update a Campaign Plan

Request

Update a campaign plan by ID

Security
Auth0
Path
campaign_plan_idintegerrequired

Numeric ID of the campaign plan object to update

Bodyapplication/json
namestring[ 1 .. 256 ] charactersrequired
durationobjectrequired
duration.​start_datestring(date-time)required

start_date can not be in the past

duration.​end_datestring(date-time)required

end_date must be between 1 and 30 days away from start_date

budgetobjectrequired
budget.​total_budgetnumber(float)[ 1 .. 99999999999999.98 ]required
budget.​currency_codestring<= 3 charactersrequired
zone_namestringrequired
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/campaign_plans/{campaign_plan_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "valid campaign plan",
    "duration": {
      "start_date": "2050-01-01T10:00:00Z",
      "end_date": "2050-01-10T23:59:00Z"
    },
    "budget": {
      "currency_code": "USD",
      "total_budget": 100
    },
    "zone_name": "America/New_York"
  }'

Responses

Campaign plane updated response

Bodyapplication/json
dataobject(campaign_plan)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "version": 0,
    "id": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "name": "string",
    "duration": { … },
    "budget": { … },
    "zone_name": "string"
  },
  "meta": {
    "status": "success"
  }
}

Strategies

Strategies

Operations

Strategy Parameters

Strategy Parameters

Operations

Strategy Templates

Strategy Templates

Operations

New Strategy Plans

New Strategy Plans

Operations

Targeting

Targeting

Operations

Targeting Attachments

TargetingAttachments

Operations

Targeting Segments

Targeting Segments

Operations

Targeting Segment Objectives

Targeting Segment Objectives

Operations

Vendor Contracts

Vendor Contracts

Operations

Contracts

Contracts

Operations

Audience Vendors

Audience Vendors

Operations

Vendors

Vendors

Operations

Atomic Creatives

Atomic Creatives

Operations

Concepts

Concepts

Operations

Creatives

Creatives

Operations

Pixel Bundles

Pixel Bundles

Operations

Pixel Providers

Pixel Providers

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

User Permissions

User Permissions

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

Timezones

Timezones

Operations

Verticals

Verticals

Operations

Supply Sources

Supply Sources

Operations

Ad Servers

Ad Servers

Operations

Segment Groups

Segment Groups

Operations