Skip to content

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

Bulk Update Campaigns

Request

Update multiple campaigns

Security
Auth0
Bodyapplication/json
updateArray of objects(campaign_bulk)non-emptyuniquerequired
update[].​archivedboolean
Default false
update[].​statusboolean
Default true
update[].​namestring[ 1 .. 256 ] characters
update[].​service_typestring
Enum"SELF""MANAGED"
update[].​io_namestring<= 256 characters
update[].​io_reference_numstring<= 32 characters
update[].​is_programmatic_guaranteedboolean
update[].​politicalboolean
Default false
update[].​source_campaign_idinteger or null(int32)
Example: 7
update[].​zone_namestringnon-empty
update[].​viewabilityobject or null(campaign_viewability)
update[].​identityobject(campaign_identity)
update[].​ad_serverobject(campaign_ad_server)
update[].​pacingobject(campaign_pacing)
update[].​attributionobject(campaign_attribution)
update[].​vendor_contractsArray of objects(vendor_contract_base)
update[].​mfa_avoidancestring
Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
update[].​targeting_identity_levelstring
Default "INHERIT"
Enum"INHERIT""INDIVIDUAL""HOUSEHOLD"
update[].​idinteger(int32)>= 1required
Example: 67
update[].​versioninteger(int32)
Example: 1
update[].​goalsobject(campaign_goals)
update[].​durationobject(campaign_duration)

Duration of campaigns must not exceed 36 months

update[].​budgetobject
update[].​frequencyobject(campaign_frequency)
update[].​inventoryobject(campaign_inventory)
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/bulk_update/campaigns \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "update": [
      {
        "archived": false,
        "status": true,
        "name": "string",
        "service_type": "SELF",
        "io_name": "string",
        "io_reference_num": "string",
        "is_programmatic_guaranteed": true,
        "political": false,
        "source_campaign_id": 7,
        "zone_name": "string",
        "viewability": {
          "vendor_id": 34,
          "type": "AUTO_TAG",
          "sample_rate": 1
        },
        "identity": {
          "device_graph_only": false,
          "bid_min_devices": 1,
          "connected_id_type": "DETERMINISTIC_FIRST"
        },
        "ad_server": {
          "ad_server_id": 19,
          "ad_server_username": "string",
          "ad_server_password": "string",
          "use_default_ad_server": true,
          "ad_server_fee": 9999999.99
        },
        "pacing": {
          "pacing_alert": 0,
          "impression_cap_automatic": false,
          "impression_cap_amount": 11,
          "impression_cap_type": "even",
          "spend_cap_type": "even",
          "spend_cap_amount": 0,
          "spend_cap_automatic": true,
          "brain_intraday_pacing": false,
          "spend_pace_ahead": false,
          "impression_pace_ahead": false
        },
        "attribution": {
          "has_custom_attribution": false,
          "custom_attribution_source": "3rd Party Attribution",
          "pc_window_minutes": 5,
          "pv_window_minutes": 6,
          "pv_pct": 100,
          "merit_pixel_id": 17,
          "conversion_type": "every",
          "conversion_variable_minutes": 1
        },
        "vendor_contracts": [
          {
            "vendor_id": 23,
            "use_mm_contract": true,
            "price": 0.1,
            "rate_card_type": "CPM"
          }
        ],
        "mfa_avoidance": "INHERIT",
        "targeting_identity_level": "INHERIT",
        "id": 67,
        "version": 1,
        "goals": {
          "goal_type": "spend",
          "goal_alert": 9999999.99,
          "goal_value": 0.0001,
          "goal_category": "audience"
        },
        "duration": {
          "start_date": "2019-08-24T14:15:22Z",
          "end_date": "2019-08-24T14:15:22Z"
        },
        "budget": {
          "total_budget": 0.1,
          "total_impression_budget": 18789,
          "currency_code": "USD",
          "margin_pct": 9999999.9999,
          "dynamic_budget_allocation_type": "SBA_AUTO_ALLOCATION",
          "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
          "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z",
          "flights": [
            {
              "id": 77,
              "start_date": "2019-08-24T14:15:22Z",
              "end_date": "2019-08-24T14:15:22Z",
              "total_budget": 0.1,
              "total_impression_budget": 12345
            }
          ]
        },
        "frequency": {
          "frequency_type": "even",
          "frequency_interval": "hour",
          "frequency_amount": 10,
          "use_mm_freq": false,
          "frequency_optimization": false
        },
        "inventory": {
          "ads_txt_verified": "ANY",
          "minimize_multi_ads": false,
          "override_suspicious_traffic_filter": false,
          "suspicious_traffic_filter_level": 25,
          "dcs_data_is_campaign_level": false,
          "restrict_targeting_to_deterministic_id": true,
          "restrict_targeting_to_same_device_id": true
        }
      }
    ]
  }'

Responses

Campaign bulk response

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

Get a Specific Campaign

Request

Get a campaign by ID

Security
Auth0
Path
campaign_idintegerrequired

Numeric ID of the campaign to get

Query
extendedboolean

Get extended properties in response

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/campaigns/{campaign_id}?extended=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Campaign response

Bodyapplication/json
Any of:
dataobject(campaign_full_with_inherited)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 7,
    "zone_name": "string",
    "viewability": { … },
    "identity": { … },
    "ad_server": { … },
    "pacing": { … },
    "attribution": { … },
    "vendor_contracts": [ … ],
    "mfa_avoidance": "INHERIT",
    "targeting_identity_level": "INHERIT",
    "id": 0,
    "version": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "locked_on": "2019-08-24T14:15:22Z",
    "v3_usage": true,
    "duration": { … },
    "goals": { … },
    "budget": { … },
    "frequency": { … },
    "inventory": { … },
    "site_lists": [ … ],
    "custom_brain_selections": [ … ],
    "strategies": { … },
    "strategy_groups": { … },
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "inherited_targeting_identity_level": "INDIVIDUAL"
  },
  "meta": {
    "status": "success"
  }
}

Update a Campaign

Request

Update a campaign by ID

Security
Auth0
Path
campaign_idintegerrequired

Numeric ID of the campaign to update

Bodyapplication/json
archivedboolean
Default false
statusboolean
Default true
namestring[ 1 .. 256 ] characters
service_typestring
Enum"SELF""MANAGED"
io_namestring<= 256 characters
io_reference_numstring<= 32 characters
is_programmatic_guaranteedboolean
politicalboolean
Default false
source_campaign_idinteger or null(int32)
Example: 7
zone_namestringnon-empty
viewabilityobject or null(campaign_viewability)
identityobject(campaign_identity)
ad_serverobject(campaign_ad_server)
pacingobject(campaign_pacing)
attributionobject(campaign_attribution)
vendor_contractsArray of objects(vendor_contract_base)
mfa_avoidancestring
Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
targeting_identity_levelstring
Default "INHERIT"
Enum"INHERIT""INDIVIDUAL""HOUSEHOLD"
versioninteger(int32)
Example: 4
goalsobject(campaign_goals)
budgetobject
frequencyobject(campaign_frequency)
inventoryobject(campaign_inventory)
site_listsArray of objects
custom_brain_selectionsArray of objects
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/campaigns/{campaign_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 7,
    "zone_name": "string",
    "viewability": {
      "vendor_id": 34,
      "type": "AUTO_TAG",
      "sample_rate": 1
    },
    "identity": {
      "device_graph_only": false,
      "bid_min_devices": 1,
      "connected_id_type": "DETERMINISTIC_FIRST"
    },
    "ad_server": {
      "ad_server_id": 19,
      "ad_server_username": "string",
      "ad_server_password": "string",
      "use_default_ad_server": true,
      "ad_server_fee": 9999999.99
    },
    "pacing": {
      "pacing_alert": 0,
      "impression_cap_automatic": false,
      "impression_cap_amount": 11,
      "impression_cap_type": "even",
      "spend_cap_type": "even",
      "spend_cap_amount": 0,
      "spend_cap_automatic": true,
      "brain_intraday_pacing": false,
      "spend_pace_ahead": false,
      "impression_pace_ahead": false
    },
    "attribution": {
      "has_custom_attribution": false,
      "custom_attribution_source": "3rd Party Attribution",
      "pc_window_minutes": 5,
      "pv_window_minutes": 6,
      "pv_pct": 100,
      "merit_pixel_id": 17,
      "conversion_type": "every",
      "conversion_variable_minutes": 1
    },
    "vendor_contracts": [
      {
        "vendor_id": 23,
        "use_mm_contract": true,
        "price": 0.1,
        "rate_card_type": "CPM"
      }
    ],
    "mfa_avoidance": "INHERIT",
    "targeting_identity_level": "INHERIT",
    "version": 4,
    "goals": {
      "goal_type": "spend",
      "goal_alert": 9999999.99,
      "goal_value": 0.0001,
      "goal_category": "audience"
    },
    "budget": {
      "total_budget": 0.1,
      "total_impression_budget": 18789,
      "currency_code": "USD",
      "margin_pct": 9999999.9999,
      "dynamic_budget_allocation_type": "SBA_AUTO_ALLOCATION",
      "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
      "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z",
      "flights": [
        {
          "id": 77,
          "start_date": "2019-08-24T14:15:22Z",
          "end_date": "2019-08-24T14:15:22Z",
          "total_budget": 0.1,
          "total_impression_budget": 12345
        }
      ]
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 10,
      "use_mm_freq": false,
      "frequency_optimization": false
    },
    "inventory": {
      "ads_txt_verified": "ANY",
      "minimize_multi_ads": false,
      "override_suspicious_traffic_filter": false,
      "suspicious_traffic_filter_level": 25,
      "dcs_data_is_campaign_level": false,
      "restrict_targeting_to_deterministic_id": true,
      "restrict_targeting_to_same_device_id": true
    },
    "site_lists": [
      {
        "id": 23,
        "assigned": true
      }
    ],
    "custom_brain_selections": [
      {
        "selection_id": 45,
        "selection_type": "Audience Target"
      }
    ]
  }'

Responses

Campaign response

Bodyapplication/json
dataobject(campaign_full_with_inherited)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 7,
    "zone_name": "string",
    "viewability": { … },
    "identity": { … },
    "ad_server": { … },
    "pacing": { … },
    "attribution": { … },
    "vendor_contracts": [ … ],
    "mfa_avoidance": "INHERIT",
    "targeting_identity_level": "INHERIT",
    "id": 0,
    "version": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "locked_on": "2019-08-24T14:15:22Z",
    "v3_usage": true,
    "duration": { … },
    "goals": { … },
    "budget": { … },
    "frequency": { … },
    "inventory": { … },
    "site_lists": [ … ],
    "custom_brain_selections": [ … ],
    "strategies": { … },
    "strategy_groups": { … },
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "inherited_targeting_identity_level": "INDIVIDUAL"
  },
  "meta": {
    "status": "success"
  }
}

List Campaigns

Request

Get a list of campaigns. The data fetched for each campaign depends on the values of query params. For example, if you use query parameter full all properties are fetched.

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. Supported operators: ==, =:, !=, >, < , >=, <=.
fullstring

To return all fields, set the value to *. For example, full=* will include all properties.

Example: full=*
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/campaigns?page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string&full=*' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List campaigns response

Bodyapplication/json
Any of:
dataArray of objects
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 Campaign

Request

Create a campaign

Security
Auth0
Bodyapplication/json
archivedboolean
Default false
statusboolean
Default true
namestring[ 1 .. 256 ] charactersrequired
service_typestringrequired
Enum"SELF""MANAGED"
io_namestring<= 256 characters
io_reference_numstring<= 32 characters
is_programmatic_guaranteedboolean
politicalboolean
Default false
source_campaign_idinteger or null(int32)
Example: 7
zone_namestringnon-empty
viewabilityobject or null(campaign_viewability)
identityobject(campaign_identity)
ad_serverobject(campaign_ad_server)
pacingobject(campaign_pacing)
attributionobject(campaign_attribution)
vendor_contractsArray of objects(vendor_contract_base)
mfa_avoidancestring
Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
targeting_identity_levelstring
Default "INHERIT"
Enum"INHERIT""INDIVIDUAL""HOUSEHOLD"
advertiser_idinteger(int32)>= 1required
Example: 8
goalsobject(campaign_goals_create)required
goals.​goal_typestringrequired
Enum"spend""reach""cpc""cpe""cpa""roi""ctr""vcr""viewability_rate""vcpm"
goals.​goal_alertnumber(float)[ 0 .. 9999999.99 ]
goals.​goal_valuenumber(float)[ 0.0001 .. 9999999.9999 ]
goals.​goal_categorystring or null
Enum"audience""engagement""response"
budgetobjectrequired
budget.​currency_codestring= 3 charactersrequired
Example: "USD"
budget.​margin_pctnumber(float)[ 0 .. 9999999.9999 ]
budget.​dynamic_budget_allocation_typestring
Default "OFF"
Enum"SBA_AUTO_ALLOCATION""SBA_RECOMMENDATIONS_ONLY""OFF"
budget.​dynamic_budget_allocation_appliedstring(date-time)
budget.​dynamic_budget_allocation_availablestring(date-time)
budget.​flightsArray of objects(campaign_budget_flights_create)non-emptyrequired
budget.​flights[].​start_datestring(date-time)required
budget.​flights[].​end_datestring(date-time)required

The latest end date of flight must be no more than 36 months after the earliest start date

budget.​flights[].​total_budgetnumber(float)required
budget.​flights[].​total_impression_budgetinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]
Example: 12345
budget.​total_budgetnumber or null(float)Deprecated
budget.​total_impression_budgetinteger or null(int64)[ -9223372036854776000 .. 9223372036854776000 ]Deprecated
Example: 18789
frequencyobject(campaign_frequency)
inventoryobject(campaign_inventory)
site_listsArray of objects
custom_brain_selectionsArray of objects
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/campaigns \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 7,
    "zone_name": "string",
    "viewability": {
      "vendor_id": 34,
      "type": "AUTO_TAG",
      "sample_rate": 1
    },
    "identity": {
      "device_graph_only": false,
      "bid_min_devices": 1,
      "connected_id_type": "DETERMINISTIC_FIRST"
    },
    "ad_server": {
      "ad_server_id": 19,
      "ad_server_username": "string",
      "ad_server_password": "string",
      "use_default_ad_server": true,
      "ad_server_fee": 9999999.99
    },
    "pacing": {
      "pacing_alert": 0,
      "impression_cap_automatic": false,
      "impression_cap_amount": 11,
      "impression_cap_type": "even",
      "spend_cap_type": "even",
      "spend_cap_amount": 0,
      "spend_cap_automatic": true,
      "brain_intraday_pacing": false,
      "spend_pace_ahead": false,
      "impression_pace_ahead": false
    },
    "attribution": {
      "has_custom_attribution": false,
      "custom_attribution_source": "3rd Party Attribution",
      "pc_window_minutes": 5,
      "pv_window_minutes": 6,
      "pv_pct": 100,
      "merit_pixel_id": 17,
      "conversion_type": "every",
      "conversion_variable_minutes": 1
    },
    "vendor_contracts": [
      {
        "vendor_id": 23,
        "use_mm_contract": true,
        "price": 0.1,
        "rate_card_type": "CPM"
      }
    ],
    "mfa_avoidance": "INHERIT",
    "targeting_identity_level": "INHERIT",
    "advertiser_id": 8,
    "goals": {
      "goal_type": "spend",
      "goal_alert": 9999999.99,
      "goal_value": 0.0001,
      "goal_category": "audience"
    },
    "budget": {
      "total_budget": 0.1,
      "total_impression_budget": 18789,
      "currency_code": "USD",
      "margin_pct": 9999999.9999,
      "dynamic_budget_allocation_type": "SBA_AUTO_ALLOCATION",
      "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
      "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z",
      "flights": [
        {
          "start_date": "2019-08-24T14:15:22Z",
          "end_date": "2019-08-24T14:15:22Z",
          "total_budget": 0.1,
          "total_impression_budget": 12345
        }
      ]
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 10,
      "use_mm_freq": false,
      "frequency_optimization": false
    },
    "inventory": {
      "ads_txt_verified": "ANY",
      "minimize_multi_ads": false,
      "override_suspicious_traffic_filter": false,
      "suspicious_traffic_filter_level": 25,
      "dcs_data_is_campaign_level": false,
      "restrict_targeting_to_deterministic_id": true,
      "restrict_targeting_to_same_device_id": true
    },
    "site_lists": [
      {
        "id": 55,
        "assigned": true
      }
    ],
    "custom_brain_selections": [
      {
        "selection_id": 23,
        "selection_type": "Audience Target"
      }
    ]
  }'

Responses

Campaign response

Bodyapplication/json
dataobject(campaign_full_with_inherited)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 7,
    "zone_name": "string",
    "viewability": { … },
    "identity": { … },
    "ad_server": { … },
    "pacing": { … },
    "attribution": { … },
    "vendor_contracts": [ … ],
    "mfa_avoidance": "INHERIT",
    "targeting_identity_level": "INHERIT",
    "id": 0,
    "version": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "locked_on": "2019-08-24T14:15:22Z",
    "v3_usage": true,
    "duration": { … },
    "goals": { … },
    "budget": { … },
    "frequency": { … },
    "inventory": { … },
    "site_lists": [ … ],
    "custom_brain_selections": [ … ],
    "strategies": { … },
    "strategy_groups": { … },
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "inherited_targeting_identity_level": "INDIVIDUAL"
  },
  "meta": {
    "status": "success"
  }
}

Campaign Audit Log

Request

Get a list of changes made to this campaign

Security
Auth0
Path
campaign_idintegerrequired

Numeric ID of the campaign

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
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/campaigns/{campaign_id}/history?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Audit log 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"
  }
}

(Legacy) Update Specific Campaign Dynamic Budget Allocation

Request

Legacy Endpoint - To be removed

Security
Auth0
Path
campaign_idintegerrequired

Numeric ID of the campaign

Query
fullstring

To return all fields, set the value to *. For example, full=* will include all properties.

Example: full=*
Bodyapplication/json
dynamic_budget_allocation_appliedstring or null(date-time)
dynamic_budget_allocation_availablestring or null(date-time)
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/campaigns/{campaign_id}/dynamic_budget_allocation?full=*' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
    "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z"
  }'

Responses

DBA updated response

Bodyapplication/json
Any of:
dataobject
metaobject(pagination metadata)
Response
application/json
{
  "data": {
    "id": 0,
    "entity_type": "string",
    "name": "string"
  },
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Copy a Campaign

Request

Copy a campaign

Security
Auth0
Path
campaign_idintegerrequired

Numeric ID of the campaign object

Bodyapplication/jsonrequired
advertiser_idinteger
namestring<= 256 charactersrequired
start_datestring(date-time)
end_datestring(date-time)
merit_pixel_idinteger or null
statusbooleanrequired
Default true
copy_assigned_site_listsboolean

If true copy everything under 'site lists'

Default false
copy_vendor_contractsboolean

If true copy everything under 'vendor contracts'

Default false
copy_brain_settingsboolean

Used to be called 'remember_source'. If true set the source_campaign_id to campaign id

Default false
copy_audience_in_brainboolean

If true copy 'custom_brain_selections'

Default false
copy_viewabilityboolean

If true then copy viewability fields

Default false
budgetobject
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/campaigns/{campaign_id}/copy' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "advertiser_id": 0,
    "name": "string",
    "start_date": "2019-08-24T14:15:22Z",
    "end_date": "2019-08-24T14:15:22Z",
    "merit_pixel_id": 0,
    "status": true,
    "copy_assigned_site_lists": false,
    "copy_vendor_contracts": false,
    "copy_brain_settings": false,
    "copy_audience_in_brain": false,
    "copy_viewability": false,
    "budget": {
      "flights": [
        {
          "start_date": "2019-08-24T14:15:22Z",
          "end_date": "2019-08-24T14:15:22Z",
          "total_budget": 0.1,
          "total_impression_budget": 0
        }
      ]
    }
  }'

Responses

Campaign response

Bodyapplication/json
dataobject(campaign_full_with_inherited)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 7,
    "zone_name": "string",
    "viewability": { … },
    "identity": { … },
    "ad_server": { … },
    "pacing": { … },
    "attribution": { … },
    "vendor_contracts": [ … ],
    "mfa_avoidance": "INHERIT",
    "targeting_identity_level": "INHERIT",
    "id": 0,
    "version": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "locked_on": "2019-08-24T14:15:22Z",
    "v3_usage": true,
    "duration": { … },
    "goals": { … },
    "budget": { … },
    "frequency": { … },
    "inventory": { … },
    "site_lists": [ … ],
    "custom_brain_selections": [ … ],
    "strategies": { … },
    "strategy_groups": { … },
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "inherited_targeting_identity_level": "INDIVIDUAL"
  },
  "meta": {
    "status": "success"
  }
}

Update Campaign Dynamic Budget Allocation

Request

This end point is restricted to a specific service account

Security
Auth0
Bodyapplication/jsonArray [
idintegerrequired

campaign id

dynamic_budget_allocation_appliedstring or null(date-time)
dynamic_budget_allocation_availablestring or null(date-time)
]
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/campaign_dba \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": 0,
      "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
      "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z"
    }
  ]'

Responses

Dba bulk response

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

List User Permissions for a Campaign

Request

List user permissions for an campaign

Security
Auth0
Path
campaign_idintegerrequired

Numeric ID of the campaign

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. Supported operators: ==, =:, !=, >, < , >=, <=.
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/campaigns/{campaign_id}/permissions?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 user permissions response

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

Bulk Campaign Audit Log

Request

Get a list of changes to these campaigns

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
Bodyapplication/json
idArray of integers(int32)non-emptyrequired
Example: [8,98,7]
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/audit_log/campaigns?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": [
      8,
      98,
      7
    ]
  }'

Responses

Audit log bulk 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"
  }
}

Campaigns Budget Flights

Campaigns Budget Flights

Operations

Campaign Plans

Campaign Plans

Operations

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