MediaMath Platform API
MediaMath Platform API
curl -i -X POST \
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/forecast \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"advertiser_id": 0,
"campaign_plan_id": 0,
"channels": [
"string"
],
"name": "string",
"feature_compatibility": "string",
"device_graph_only": true,
"id": 0,
"version": 0,
"campaign_id": 0,
"zone_name": "America/New_York",
"campaign_service_type": "string",
"type": "string",
"duration": {
"use_campaign_start": true,
"use_campaign_end": true,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z"
},
"budget": {
"budget": 0.1,
"currency_code": "string"
},
"goals": {
"goal_type": "spend",
"goal_value": 999999999.9999,
"min_bid": 9999999.99,
"max_bid": 0.01,
"roi_target": 999999999.99,
"bid_min_devices": 0,
"bid_aggressiveness": 100,
"bid_price_is_media_only": true,
"max_bid_wm": 9999999.99,
"use_bid_shading": true
},
"frequency": {
"frequency_type": "even",
"frequency_interval": "hour",
"frequency_amount": 0,
"frequency_optimization": true
},
"inventory": {
"run_on_all_pmp": true,
"run_on_all_exchanges": true,
"site_restriction_transparent_urls": true,
"domain_restrictions": {
"include": [
{
"domain": "www.mediamath.com",
"target_type": "DOMAIN"
}
],
"exclude": [
{
"domain": "www.mediamath.com",
"target_type": "DOMAIN"
}
]
},
"site_lists": [
{
"site_list_id": 0,
"assigned": true
}
],
"deals": [
{
"deal_id": 0
}
],
"deal_groups": [
{
"deal_group_id": 0
}
],
"supply_sources": [
{
"supply_source_id": 0
}
]
},
"targeting": {
"fold_position": [
"ABOVE"
],
"audience": {
"include": [
{
"operator": "AND",
"segments": [
{
"audience_segment_id": 0,
"user_cpm": 0.1
}
]
}
],
"exclude": {
"operator": "AND",
"segments": [
{
"audience_segment_id": 0,
"user_cpm": 0.1
}
]
}
},
"contextual": {
"include": [
{
"code": "string",
"operator": "AND",
"segments": [
{
"targeting_segment_id": 0,
"user_cpm": 0.1
}
]
}
],
"exclude": {
"code": "string",
"operator": "AND",
"segments": [
{
"targeting_segment_id": 0,
"user_cpm": 0.1
}
]
}
},
"postal_codes": {
"restriction": "INCLUDE",
"codes": [
"us-14392",
"us-24981",
"us-25632",
"us-16191",
"us-48574",
"us14392",
"us24981",
"us25632",
"us16191",
"us48574",
"14392",
"24981",
"25632",
"16191",
"48574"
]
},
"geofence": {
"include": {
"operator": "AND",
"segments": [
{
"geofence_segment_id": 0
}
]
},
"exclude": {
"operator": "AND",
"segments": [
{
"geofence_segment_id": 0
}
]
}
},
"my_data": {
"include": {
"operator": "AND",
"pixels": [
{
"pixel_id": 0
}
]
},
"exclude": {
"operator": "AND",
"pixels": [
{
"pixel_id": 0
}
]
}
},
"location": {
"include": [
{
"operator": "string",
"target_value_id": 0,
"code": "DMAX"
}
],
"exclude": [
{
"operator": "string",
"target_value_id": 0,
"code": "DMAX"
}
]
},
"technology": {
"include": [
{
"operator": "string",
"code": "BSER",
"target_value_id": 0
}
],
"exclude": [
{
"operator": "string",
"code": "BSER",
"target_value_id": 0
}
]
},
"ip_addresses": {
"restriction": "INCLUDE",
"codes": [
"string"
]
},
"day_parts": [
{
"user_time": true,
"start_hour": 1,
"end_hour": 5,
"days": [
"M",
"T",
"W",
"S",
"U"
]
}
],
"recency": [
{
"pixel_id": 0,
"from_hour": 0,
"to_hour": 0
}
],
"language_codes": [
{
"code": "string",
"name": "string"
}
]
},
"creatives": {
"ad_expandable": true,
"ad_formats": [
"string"
],
"ad_sizes": [
"string"
]
}
}'
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": { … }, "budget": { … }, "goals": { … }, "frequency": { … }, "inventory": { … }, "targeting": { … }, "creatives": { … } }, "meta": { "status": "success" } }
curl -i -X POST \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/{strategy_plan_id}/forecast' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": { … }, "budget": { … }, "goals": { … }, "frequency": { … }, "inventory": { … }, "targeting": { … }, "creatives": { … } }, "meta": { "status": "success" } }
curl -i -X GET \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/{strategy_plan_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": { … }, "budget": { … }, "goals": { … }, "frequency": { … }, "inventory": { … }, "targeting": { … }, "creatives": { … } }, "meta": { "status": "success" } }
curl -i -X POST \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/{strategy_plan_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"version": 0,
"campaign_plan_id": 0,
"channels": [
"string"
],
"name": "string",
"feature_compatibility": "string",
"device_graph_only": true,
"id": 0,
"campaign_id": 0,
"zone_name": "America/New_York",
"campaign_service_type": "string",
"type": "string",
"duration": {
"use_campaign_start": true,
"use_campaign_end": true,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z"
},
"budget": {
"budget": 0.1,
"currency_code": "string"
},
"goals": {
"goal_type": "spend",
"goal_value": 999999999.9999,
"min_bid": 9999999.99,
"max_bid": 0.01,
"roi_target": 999999999.99,
"bid_min_devices": 0,
"bid_aggressiveness": 100,
"bid_price_is_media_only": true,
"max_bid_wm": 9999999.99,
"use_bid_shading": true
},
"frequency": {
"frequency_type": "even",
"frequency_interval": "hour",
"frequency_amount": 0,
"frequency_optimization": true
},
"inventory": {
"run_on_all_pmp": true,
"run_on_all_exchanges": true,
"site_restriction_transparent_urls": true,
"domain_restrictions": {
"include": [
{
"domain": "www.mediamath.com",
"target_type": "DOMAIN"
}
],
"exclude": [
{
"domain": "www.mediamath.com",
"target_type": "DOMAIN"
}
]
},
"site_lists": [
{
"site_list_id": 0,
"assigned": true
}
],
"deals": [
{
"deal_id": 0
}
],
"deal_groups": [
{
"deal_group_id": 0
}
],
"supply_sources": [
{
"supply_source_id": 0
}
]
},
"targeting": {
"fold_position": [
"ABOVE"
],
"audience": {
"include": [
{
"operator": "AND",
"segments": [
{
"audience_segment_id": 0,
"user_cpm": 0.1
}
]
}
],
"exclude": {
"operator": "AND",
"segments": [
{
"audience_segment_id": 0,
"user_cpm": 0.1
}
]
}
},
"contextual": {
"include": [
{
"code": "string",
"operator": "AND",
"segments": [
{
"targeting_segment_id": 0,
"user_cpm": 0.1
}
]
}
],
"exclude": {
"code": "string",
"operator": "AND",
"segments": [
{
"targeting_segment_id": 0,
"user_cpm": 0.1
}
]
}
},
"postal_codes": {
"restriction": "INCLUDE",
"codes": [
"us-14392",
"us-24981",
"us-25632",
"us-16191",
"us-48574",
"us14392",
"us24981",
"us25632",
"us16191",
"us48574",
"14392",
"24981",
"25632",
"16191",
"48574"
]
},
"geofence": {
"include": {
"operator": "AND",
"segments": [
{
"geofence_segment_id": 0
}
]
},
"exclude": {
"operator": "AND",
"segments": [
{
"geofence_segment_id": 0
}
]
}
},
"my_data": {
"include": {
"operator": "AND",
"pixels": [
{
"pixel_id": 0
}
]
},
"exclude": {
"operator": "AND",
"pixels": [
{
"pixel_id": 0
}
]
}
},
"location": {
"include": [
{
"operator": "string",
"target_value_id": 0,
"code": "DMAX"
}
],
"exclude": [
{
"operator": "string",
"target_value_id": 0,
"code": "DMAX"
}
]
},
"technology": {
"include": [
{
"operator": "string",
"code": "BSER",
"target_value_id": 0
}
],
"exclude": [
{
"operator": "string",
"code": "BSER",
"target_value_id": 0
}
]
},
"ip_addresses": {
"restriction": "INCLUDE",
"codes": [
"string"
]
},
"day_parts": [
{
"user_time": true,
"start_hour": 1,
"end_hour": 5,
"days": [
"M",
"T",
"W",
"S",
"U"
]
}
],
"recency": [
{
"pixel_id": 0,
"from_hour": 0,
"to_hour": 0
}
],
"language_codes": [
{
"code": "string",
"name": "string"
}
]
},
"creatives": {
"ad_expandable": true,
"ad_formats": [
"string"
],
"ad_sizes": [
"string"
]
}
}'
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": { … }, "budget": { … }, "goals": { … }, "frequency": { … }, "inventory": { … }, "targeting": { … }, "creatives": { … } }, "meta": { "status": "success" } }
curl -i -X DELETE \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans/{strategy_plan_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": {}, "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
.
curl -i -X GET \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_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>'
{ "data": [ { … } ], "meta": { "status": "success", "count": 10, "total_count": 100, "offset": 0, "next_page": "string", "prev_page": "string" } }
curl -i -X POST \
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/new_strategy_plans \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"advertiser_id": 0,
"campaign_plan_id": 0,
"channels": [
"string"
],
"name": "string",
"feature_compatibility": "string",
"device_graph_only": true,
"id": 0,
"version": 0,
"campaign_id": 0,
"zone_name": "America/New_York",
"campaign_service_type": "string",
"type": "string",
"duration": {
"use_campaign_start": true,
"use_campaign_end": true,
"start_date": "2019-08-24T14:15:22Z",
"end_date": "2019-08-24T14:15:22Z"
},
"budget": {
"budget": 0.1,
"currency_code": "string"
},
"goals": {
"goal_type": "spend",
"goal_value": 999999999.9999,
"min_bid": 9999999.99,
"max_bid": 0.01,
"roi_target": 999999999.99,
"bid_min_devices": 0,
"bid_aggressiveness": 100,
"bid_price_is_media_only": true,
"max_bid_wm": 9999999.99,
"use_bid_shading": true
},
"frequency": {
"frequency_type": "even",
"frequency_interval": "hour",
"frequency_amount": 0,
"frequency_optimization": true
},
"inventory": {
"run_on_all_pmp": true,
"run_on_all_exchanges": true,
"site_restriction_transparent_urls": true,
"domain_restrictions": {
"include": [
{
"domain": "www.mediamath.com",
"target_type": "DOMAIN"
}
],
"exclude": [
{
"domain": "www.mediamath.com",
"target_type": "DOMAIN"
}
]
},
"site_lists": [
{
"site_list_id": 0,
"assigned": true
}
],
"deals": [
{
"deal_id": 0
}
],
"deal_groups": [
{
"deal_group_id": 0
}
],
"supply_sources": [
{
"supply_source_id": 0
}
]
},
"targeting": {
"fold_position": [
"ABOVE"
],
"audience": {
"include": [
{
"operator": "AND",
"segments": [
{
"audience_segment_id": 0,
"user_cpm": 0.1
}
]
}
],
"exclude": {
"operator": "AND",
"segments": [
{
"audience_segment_id": 0,
"user_cpm": 0.1
}
]
}
},
"contextual": {
"include": [
{
"code": "string",
"operator": "AND",
"segments": [
{
"targeting_segment_id": 0,
"user_cpm": 0.1
}
]
}
],
"exclude": {
"code": "string",
"operator": "AND",
"segments": [
{
"targeting_segment_id": 0,
"user_cpm": 0.1
}
]
}
},
"postal_codes": {
"restriction": "INCLUDE",
"codes": [
"us-14392",
"us-24981",
"us-25632",
"us-16191",
"us-48574",
"us14392",
"us24981",
"us25632",
"us16191",
"us48574",
"14392",
"24981",
"25632",
"16191",
"48574"
]
},
"geofence": {
"include": {
"operator": "AND",
"segments": [
{
"geofence_segment_id": 0
}
]
},
"exclude": {
"operator": "AND",
"segments": [
{
"geofence_segment_id": 0
}
]
}
},
"my_data": {
"include": {
"operator": "AND",
"pixels": [
{
"pixel_id": 0
}
]
},
"exclude": {
"operator": "AND",
"pixels": [
{
"pixel_id": 0
}
]
}
},
"location": {
"include": [
{
"operator": "string",
"target_value_id": 0,
"code": "DMAX"
}
],
"exclude": [
{
"operator": "string",
"target_value_id": 0,
"code": "DMAX"
}
]
},
"technology": {
"include": [
{
"operator": "string",
"code": "BSER",
"target_value_id": 0
}
],
"exclude": [
{
"operator": "string",
"code": "BSER",
"target_value_id": 0
}
]
},
"ip_addresses": {
"restriction": "INCLUDE",
"codes": [
"string"
]
},
"day_parts": [
{
"user_time": true,
"start_hour": 1,
"end_hour": 5,
"days": [
"M",
"T",
"W",
"S",
"U"
]
}
],
"recency": [
{
"pixel_id": 0,
"from_hour": 0,
"to_hour": 0
}
],
"language_codes": [
{
"code": "string",
"name": "string"
}
]
},
"creatives": {
"ad_expandable": true,
"ad_formats": [
"string"
],
"ad_sizes": [
"string"
]
}
}'
{ "data": { "campaign_start_date": "2019-08-24T14:15:22Z", "campaign_end_date": "2019-08-24T14:15:22Z", "campaign_zone_name": "string", "name": "string", "feature_compatibility": "string", "device_graph_only": true, "id": 0, "version": 0, "campaign_id": 0, "zone_name": "America/New_York", "campaign_service_type": "string", "type": "string", "duration": { … }, "budget": { … }, "goals": { … }, "frequency": { … }, "inventory": { … }, "targeting": { … }, "creatives": { … } }, "meta": { "status": "success" } }