MediaMath Platform API
https://apidocs.mediamath.com/
https://apidocs.mediamath.com/campaigns/{campaign_id}
curl -i -X GET \
'https://apidocs.mediamath.com/campaigns/{campaign_id}?extended=true' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "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": 0, "zone_name": "string", "id": 0, "version": 0, "advertiser_id": 0, "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z", "identity": { "device_graph_only": false, "bid_min_devices": 1, "connected_id_type": "DETERMINISTIC_FIRST" }, "ad_server": { "ad_server_id": 0, "ad_server_username": "string", "ad_server_password": "string", "use_default_ad_server": true, "ad_server_fee": 9999999.99 }, "duration": { "start_date": "2019-08-24T14:15:22Z", "end_date": "2019-08-24T14:15:22Z", "initial_start_date": "2019-08-24T14:15:22Z" }, "goals": { "goal_type": "spend", "goal_alert": 9999999.99, "goal_value": 0.0001, "goal_category": "audience" }, "budget": { "total_budget": 0.1, "total_impression_budget": 0, "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": [ … ] }, "frequency_cap": { "frequency_type": "even", "frequency_interval": "hour", "frequency_amount": 0, "use_mm_freq": false, "frequency_optimization": false }, "pacing": { "pacing_alert": 0, "impression_cap_automatic": false, "impression_cap_amount": 0, "impression_cap_type": "even", "spend_cap_type": "even", "spend_cap_amount": 0, "spend_cap_automatic": true, "brain_intraday_pacing": 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": false, "restrict_targeting_to_same_device_id": true, "effective_ads_txt_verified": "ANY" }, "attribution": { "has_custom_attribution": false, "custom_attribution_source": "3rd Party Attribution", "pc_window_minutes": 0, "pv_window_minutes": 0, "pv_pct": 100, "merit_pixel_id": 0, "conversion_type": "every", "conversion_variable_minutes": 1 }, "budget_flights": [ { … } ], "viewability": { "vendor_id": 0, "type": "AUTO_TAG", "sample_rate": 1 }, "vendor_contracts": [ { … } ], "site_lists": [ { … } ], "custom_brain_selections": [ { … } ], "strategies": { "count": 0, "strategies_list": [ … ], "distinct_strategy_goal_types": [ … ] }, "strategy_groups": { "count": 0, "strategy_groups_list": [ … ] }, "mfa_avoidance": "INHERIT" }
https://apidocs.mediamath.com/campaigns/{campaign_id}
curl -i -X POST \
'https://apidocs.mediamath.com/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": 0,
"zone_name": "string",
"advertiser_id": 1,
"identity": {
"device_graph_only": false,
"bid_min_devices": 1,
"connected_id_type": "DETERMINISTIC_FIRST"
},
"ad_server": {
"ad_server_id": 0,
"ad_server_username": "string",
"ad_server_password": "string",
"use_default_ad_server": true,
"ad_server_fee": 9999999.99
},
"goals": {
"goal_type": "spend",
"goal_alert": 9999999.99,
"goal_value": 0.0001,
"goal_category": "audience"
},
"budget": {
"total_budget": 0.1,
"total_impression_budget": 0,
"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": 0
}
]
},
"frequency": {
"frequency_type": "even",
"frequency_interval": "hour",
"frequency_amount": 0,
"use_mm_freq": false,
"frequency_optimization": false
},
"pacing": {
"pacing_alert": 0,
"impression_cap_automatic": false,
"impression_cap_amount": 0,
"impression_cap_type": "even",
"spend_cap_type": "even",
"spend_cap_amount": 0,
"spend_cap_automatic": true,
"brain_intraday_pacing": 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": false,
"restrict_targeting_to_same_device_id": true
},
"attribution": {
"has_custom_attribution": false,
"custom_attribution_source": "3rd Party Attribution",
"pc_window_minutes": 0,
"pv_window_minutes": 0,
"pv_pct": 100,
"merit_pixel_id": 0,
"conversion_type": "every",
"conversion_variable_minutes": 1
},
"viewability": {
"vendor_id": 0,
"type": "AUTO_TAG",
"sample_rate": 1
},
"vendor_contracts": [
{
"vendor_id": 0,
"use_mm_contract": true,
"price": 0.1,
"rate_card_type": "CPM",
"site_lists": {
"id": 0,
"name": "string",
"version": 0,
"status": true,
"organization_id": 0,
"restriction": "string",
"filename": "string",
"campaign_id": 0,
"assigned": true,
"sites_count": 0,
"sites_count_app": 0,
"sites_count_domain": 0
}
}
],
"site_lists": [
{
"id": 0,
"assigned": true
}
],
"custom_brain_selections": [
{
"selection_id": 0,
"selection_type": "Audience Target"
}
],
"mfa_avoidance": "INHERIT"
}'
{ "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": 0, "zone_name": "string", "id": 0, "version": 0, "advertiser_id": 0, "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z", "identity": { … }, "ad_server": { … }, "duration": { … }, "goals": { … }, "budget": { … }, "frequency_cap": { … }, "pacing": { … }, "inventory": { … }, "attribution": { … }, "budget_flights": [ … ], "viewability": { … }, "vendor_contracts": [ … ], "site_lists": [ … ], "custom_brain_selections": [ … ], "strategies": { … }, "strategy_groups": { … }, "mfa_avoidance": "INHERIT" }, "meta": { "status": "success" } }
Number of elements in the collection to retrieve
Index of the first element in the collection to retrieve
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
.
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.https://apidocs.mediamath.com/campaigns
curl -i -X GET \
'https://apidocs.mediamath.com/campaigns?full=*&page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": [ { … } ], "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }
The latest end date of flight must be no more than 36 months after the earliest start date
https://apidocs.mediamath.com/campaigns
curl -i -X POST \
https://apidocs.mediamath.com/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": 0,
"zone_name": "string",
"advertiser_id": 1,
"identity": {
"device_graph_only": false,
"bid_min_devices": 1,
"connected_id_type": "DETERMINISTIC_FIRST"
},
"ad_server": {
"ad_server_id": 0,
"ad_server_username": "string",
"ad_server_password": "string",
"use_default_ad_server": true,
"ad_server_fee": 9999999.99
},
"goals": {
"goal_type": "spend",
"goal_alert": 9999999.99,
"goal_value": 0.0001,
"goal_category": "audience"
},
"budget": {
"total_budget": 0.1,
"total_impression_budget": 0,
"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": 0
}
]
},
"frequency": {
"frequency_type": "even",
"frequency_interval": "hour",
"frequency_amount": 0,
"use_mm_freq": false,
"frequency_optimization": false
},
"pacing": {
"pacing_alert": 0,
"impression_cap_automatic": false,
"impression_cap_amount": 0,
"impression_cap_type": "even",
"spend_cap_type": "even",
"spend_cap_amount": 0,
"spend_cap_automatic": true,
"brain_intraday_pacing": 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": false,
"restrict_targeting_to_same_device_id": true
},
"attribution": {
"has_custom_attribution": false,
"custom_attribution_source": "3rd Party Attribution",
"pc_window_minutes": 0,
"pv_window_minutes": 0,
"pv_pct": 100,
"merit_pixel_id": 0,
"conversion_type": "every",
"conversion_variable_minutes": 1
},
"viewability": {
"vendor_id": 0,
"type": "AUTO_TAG",
"sample_rate": 1
},
"vendor_contracts": [
{
"vendor_id": 0,
"use_mm_contract": true,
"price": 0.1,
"rate_card_type": "CPM",
"site_lists": {
"id": 0,
"name": "string",
"version": 0,
"status": true,
"organization_id": 0,
"restriction": "string",
"filename": "string",
"campaign_id": 0,
"assigned": true,
"sites_count": 0,
"sites_count_app": 0,
"sites_count_domain": 0
}
}
],
"site_lists": [
{
"id": 0,
"assigned": true
}
],
"custom_brain_selections": [
{
"selection_id": 0,
"selection_type": "Audience Target"
}
],
"mfa_avoidance": "INHERIT"
}'
{ "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": 0, "zone_name": "string", "id": 0, "version": 0, "advertiser_id": 0, "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z", "identity": { … }, "ad_server": { … }, "duration": { … }, "goals": { … }, "budget": { … }, "frequency_cap": { … }, "pacing": { … }, "inventory": { … }, "attribution": { … }, "budget_flights": [ … ], "viewability": { … }, "vendor_contracts": [ … ], "site_lists": [ … ], "custom_brain_selections": [ … ], "strategies": { … }, "strategy_groups": { … }, "mfa_avoidance": "INHERIT" }, "meta": { "status": "success" } }
https://apidocs.mediamath.com/campaigns/{campaign_id}/history
curl -i -X GET \
'https://apidocs.mediamath.com/campaigns/{campaign_id}/history?page_limit=100&page_offset=0' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": [ { … } ], "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }
https://apidocs.mediamath.com/campaigns/{campaign_id}/budget_flights
curl -i -X GET \
'https://apidocs.mediamath.com/campaigns/{campaign_id}/budget_flights?full=*&page_limit=100&page_offset=0' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": [ { … } ], "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }
https://apidocs.mediamath.com/campaigns/{campaign_id}/dynamic_budget_allocation
curl -i -X POST \
'https://apidocs.mediamath.com/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"
}'
{ "data": { "id": 0, "entity_type": "string", "name": "string" }, "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }
https://apidocs.mediamath.com/campaign_dba
curl -i -X POST \
https://apidocs.mediamath.com/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"
}
]'
{ "data": [ { … } ], "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }
Number of elements in the collection to retrieve
Index of the first element in the collection to retrieve
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
.
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.https://apidocs.mediamath.com/campaigns/{campaign_id}/permissions
curl -i -X GET \
'https://apidocs.mediamath.com/campaigns/{campaign_id}/permissions?page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": [ { … } ], "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }
https://apidocs.mediamath.com/audit_log/campaigns
curl -i -X POST \
'https://apidocs.mediamath.com/audit_log/campaigns?page_limit=100&page_offset=0' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"id": [
0
]
}'
{ "data": [ { … } ], "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }