MediaMath Platform API
MediaMath Platform API
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.curl -i -X GET \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations?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": { "count": 3, "total_count": 100, "offset": 0, "status": "success" } }
The name of the organization with whom the contract is held. This can be an agency holding company, agency, advertiser, network, or other media or data buying entity.
The org_type
field is an array that specifies the type of organization.
This field enables the Data Co-op functionality across all the Advertisers under this organization. Cross-Advertiser Pixel Targeting allows Advertisers to target other Advertiser Event Pixels within their Agency and any other similarly enabled Agency under the same Organization.
Set flag to 'on’ to be able to override default org wide suspicious traffic filter level.
Specify an organization-wide level of suspicious traffic filtering to use. See the Knowledge Base for additional details about this feature. This setting will only take affect if the organization's override_suspicious_traffic_filter property is set to 'on'. If override_suspicious_traffic_filter is enabled and suspicious_traffic_filter_level is set to 0, all fraud and suspicious traffic will be filtered.
Set flag to 'on’ to show an opt out button on the organization's ads (additional CPM fee will apply when on).
This is the name of the primary internal MediaMath contact of the Organization.
Passed to ADX upon creative registration so ADX knows which seat we're registering under.
This is the primary contact at the organization regarding contract issues.
The primary address line, typically includes street address and number.
The secondary address line, used for additional information such as apartment, suite, or unit number.
The country of the address, represented as a 2-character ISO country code.
The phone number associated with the address, including country code if applicable.
Currency code for the campaign budget and spend, as well as billing.
curl -i -X POST \
https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"org_type": [
"buyer"
],
"status": true,
"website": "string",
"facebook": "string",
"linkedin": "string",
"twitter": "string",
"allow_x_agency_pixels": true,
"allow_byo_price": true,
"opt_out_connected_id": true,
"opt_out_connected_id_mathid": true,
"override_suspicious_traffic_filter": true,
"restrict_targeting_to_same_device_id": true,
"restrict_targeting_to_deterministic_id": true,
"suspicious_traffic_filter_level": 100,
"use_ads_txt": true,
"use_evidon_opt_out": true,
"eligible_for_data_sharing": true,
"holding_org_id": 0,
"service_provider_ccpa": true,
"mm_contact_name": "string",
"adx_seat_account_id": 1,
"connected_id_type": "DETERMINISTIC_FIRST",
"contact_name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"state": "st",
"zip": "string",
"country": "st",
"phone": "string",
"currency_code": "str",
"billing_country_code": "string",
"dmp_enabled": "enabled",
"tag_ruleset": "string"
}'
{ "data": { "name": "string", "org_type": [ … ], "status": true, "website": "string", "facebook": "string", "linkedin": "string", "twitter": "string", "allow_x_agency_pixels": true, "allow_byo_price": true, "opt_out_connected_id": true, "opt_out_connected_id_mathid": true, "override_suspicious_traffic_filter": true, "restrict_targeting_to_same_device_id": true, "restrict_targeting_to_deterministic_id": true, "suspicious_traffic_filter_level": 100, "use_ads_txt": true, "use_evidon_opt_out": true, "eligible_for_data_sharing": true, "holding_org_id": 0, "service_provider_ccpa": true, "mm_contact_name": "string", "adx_seat_account_id": 1, "connected_id_type": "DETERMINISTIC_FIRST", "contact_name": "string", "address_1": "string", "address_2": "string", "city": "string", "state": "st", "zip": "string", "country": "st", "phone": "string", "currency_code": "str", "billing_country_code": "string", "dmp_enabled": "enabled", "tag_ruleset": "string", "id": 0, "created_on": "2019-08-24T14:15:22Z", "entity_type": "string", "terminated": true, "updated_on": "2019-08-24T14:15:22Z", "version": 0 }, "meta": { "status": "success" } }
curl -i -X GET \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations/{organization_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "data": { "name": "string", "org_type": [ … ], "status": true, "website": "string", "facebook": "string", "linkedin": "string", "twitter": "string", "allow_x_agency_pixels": true, "allow_byo_price": true, "opt_out_connected_id": true, "opt_out_connected_id_mathid": true, "override_suspicious_traffic_filter": true, "restrict_targeting_to_same_device_id": true, "restrict_targeting_to_deterministic_id": true, "suspicious_traffic_filter_level": 100, "use_ads_txt": true, "use_evidon_opt_out": true, "eligible_for_data_sharing": true, "holding_org_id": 0, "service_provider_ccpa": true, "mm_contact_name": "string", "adx_seat_account_id": 1, "connected_id_type": "DETERMINISTIC_FIRST", "contact_name": "string", "address_1": "string", "address_2": "string", "city": "string", "state": "st", "zip": "string", "country": "st", "phone": "string", "currency_code": "str", "billing_country_code": "string", "dmp_enabled": "enabled", "tag_ruleset": "string", "id": 0, "created_on": "2019-08-24T14:15:22Z", "entity_type": "string", "terminated": true, "updated_on": "2019-08-24T14:15:22Z", "version": 0 }, "meta": { "status": "success" } }
curl -i -X POST \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations/{organization_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"org_type": [
"buyer"
],
"status": true,
"website": "string",
"facebook": "string",
"linkedin": "string",
"twitter": "string",
"allow_x_agency_pixels": true,
"allow_byo_price": true,
"opt_out_connected_id": true,
"opt_out_connected_id_mathid": true,
"override_suspicious_traffic_filter": true,
"restrict_targeting_to_same_device_id": true,
"restrict_targeting_to_deterministic_id": true,
"suspicious_traffic_filter_level": 100,
"use_ads_txt": true,
"use_evidon_opt_out": true,
"eligible_for_data_sharing": true,
"holding_org_id": 0,
"service_provider_ccpa": true,
"mm_contact_name": "string",
"adx_seat_account_id": 1,
"connected_id_type": "DETERMINISTIC_FIRST",
"contact_name": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"state": "st",
"zip": "string",
"country": "st",
"phone": "string",
"currency_code": "str",
"billing_country_code": "string",
"dmp_enabled": "enabled",
"terminated": true,
"version": 0,
"tag_ruleset": "string"
}'
{ "data": { "name": "string", "org_type": [ … ], "status": true, "website": "string", "facebook": "string", "linkedin": "string", "twitter": "string", "allow_x_agency_pixels": true, "allow_byo_price": true, "opt_out_connected_id": true, "opt_out_connected_id_mathid": true, "override_suspicious_traffic_filter": true, "restrict_targeting_to_same_device_id": true, "restrict_targeting_to_deterministic_id": true, "suspicious_traffic_filter_level": 100, "use_ads_txt": true, "use_evidon_opt_out": true, "eligible_for_data_sharing": true, "holding_org_id": 0, "service_provider_ccpa": true, "mm_contact_name": "string", "adx_seat_account_id": 1, "connected_id_type": "DETERMINISTIC_FIRST", "contact_name": "string", "address_1": "string", "address_2": "string", "city": "string", "state": "st", "zip": "string", "country": "st", "phone": "string", "currency_code": "str", "billing_country_code": "string", "dmp_enabled": "enabled", "tag_ruleset": "string", "id": 0, "created_on": "2019-08-24T14:15:22Z", "entity_type": "string", "terminated": true, "updated_on": "2019-08-24T14:15:22Z", "version": 0 }, "meta": { "status": "success" } }
curl -i -X GET \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations/{organization_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" } }
curl -i -X POST \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/audit_log/organizations?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" } }
curl -i -X GET \
'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/organizations/{organization_id}/permissions?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" } }