Contracts
/
List Contracts

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
https://apidocs.mediamath.com/

Organizations

Organizations

Operations

Agencies

Agencies

Operations

Advertisers

Advertisers

Operations

Campaigns

Campaigns

Operations

Strategies

Strategies

Operations

Targeting

Targeting

Operations

Vendor Contracts

Vendor Contracts

Operations

Strategy Templates

Strategy Templates

Operations

Atomic Creatives

Atomic Creatives

Operations

Concepts

Concepts

Operations

Creatives

Creatives

Operations

Pixel Bundles

Pixel Bundles

Operations

Campaign Plans

Campaign Plans

Operations

Strategy Plans

Strategy Plans

Operations

Bulk Update

Bulk Update

Operations

Marketplaces

Marketplaces

Operations

Users

Users

Operations

Enterprise Controls

Enterprise Controls

Operations

General

General

Operations

Currency Rates

Currency Rates

Operations

Site Lists

Site Lists

Operations

Timezones

Timezones

Operations

Strategy Groups

Strategy Groups

Operations

Strategy Day Parts

Strategy Day Parts

Operations

Strategy Deals

Strategy Deals

Operations

Strategy IP Addresses

Strategy IP Addresses

Operations

Strategy Concepts

Strategy Concepts

Operations

Targeting Segments

Targeting Segments

Operations

Strategy Target Values

Strategy Target Values

Operations

Contracts

Contracts

Operations

Create A Contract

Request

Create a new Contract

Bodyapplication/jsonrequired
idinteger
versioninteger
organization_idintegerrequired
effective_start_datestring(date-time)required
effective_end_datestring(date-time)required
platform_monthly_minnumber(float)required
platform_access_fee_pctnumber or null(float)required
platform_access_fee_cpmnumber or null(float)
platform_access_fee_fixednumber or null(float)
managed_service_fee_pctnumber or null(float)required
managed_service_fee_cpmnumber or null(float)
managed_service_fee_fixednumber or null(float)
optimization_fee_pctnumber or null(float)required
optimization_fee_cpmnumber or null(float)
optimization_fee_fixednumber or null(float)
pmp_optimization_off_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"
pmp_optimization_off_fee_pctnumber or null(float)required
pmp_optimization_off_fee_cpmnumber or null(float)
pmp_optimization_on_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"
pmp_optimization_on_fee_pctnumber or null(float)required
pmp_optimization_on_fee_cpmnumber or null(float)
dmp_fee_unitstring or null
Enum"PCT_TOTAL_COST""CPM""CPTS"
dmp_fee_pctnumber or null(float)
dmp_fee_cpmnumber or null(float)
dmp_fee_cptsnumber or null(float)
signals_fee_unitstring or null
Enum"PCT_TOTAL_COST""CPM"
signals_fee_pctnumber or null(float)
signals_fee_cpmnumber or null(float)
t1_apps_fee_unitstring or null
Enum"PCT_TOTAL_COST""CPM"
t1_apps_fee_pctnumber or null(float)
t1_apps_fee_cpmnumber or null(float)
spend_capnumber or null(float)
platform_access_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"
managed_service_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"
optimization_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"
profit_share_fee_pctnumber(float)required
exclude_agency_marginbooleanrequired
Default false
t1_as_fee_cpmnumber(float)required
Default 0.05
evidon_privacy_cost_cpmnumber(float)
Default 0.02
peer39_channel_fee_cpmnumber or null(float)
peer39_custom_fee_cpmnumber or null(float)
peer39_safety_fee_cpmnumber(float)
peer39_quality_fee_cpmnumber(float)
fbx_dynamic_cpmnumber(float)
Default 0.3
t1_vads_fee_cpmnumber(float)required
Default 0.25
adaptive_segment_cpmnumber(float)required
Default 0
external_media_tracking_cpmnumber(float)
Default 0
currency_codestring= 3 charactersrequired
t1_html5_fee_cpmnumber(float)required
Default 0.05
viewability_display_samplenumber or null(float)
viewability_display_all_impsnumber or null(float)
viewability_video_samplenumber or null(float)
viewability_video_all_impsnumber or null(float)
standard_segment_cpmnumber(float)required
Default 0.1
connected_id_costnumber(float)
Default 0
financing_costnumber(float)
Default 0
audience_verification_costnumber(float)
Default 0.25
programmatic_guaranteed_platform_access_fee_cpmnumber or null(float)
programmatic_guaranteed_platform_access_fee_pctnumber or null(float)required
programmatic_guaranteed_platform_access_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"
media_enablement_fee_cpmnumber or null(float)
media_enablement_fee_pctnumber or null(float)
media_enablement_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_CLEAR"
source_platform_access_fee_cpmnumber or null(float)
source_platform_access_fee_pctnumber or null(float)
source_platform_access_fee_unitstring
Enum"PCT_TOTAL_COST""CPM"
country_tax_withholding_fee_cpmnumber or null(float)
country_tax_withholding_fee_pctnumber or null(float)required
country_tax_withholding_fee_unitstring
Enum"CPM""PCT_CLEAR""PCT_NET_TOTAL_SPEND"
partnership_rebate_fee_cpmnumber or null(float)
partnership_rebate_fee_pctnumber or null(float)
partnership_rebate_fee_unitstring
Enum"CPM""PCT_CLEAR""PCT_NET_TOTAL_SPEND"
cross_device_fee_cpmnumber or null(float)
dba_optimization_fee_cpmnumber or null(float)
dba_optimization_fee_pctnumber or null(float)
dba_optimization_fee_unitstring
Enum"CPM""PCT_MEDIA"
audio_video_platform_access_fee_cpmnumber or null(float)
audio_video_platform_access_fee_pctnumber or null(float)required
audio_video_platform_access_fee_unitstring
Enum"CPM""PCT_TOTAL_COST"
curl -i -X POST \
  https://apidocs.mediamath.com/contracts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "version": 0,
    "organization_id": 0,
    "effective_start_date": "2019-08-24T14:15:22Z",
    "effective_end_date": "2019-08-24T14:15:22Z",
    "platform_monthly_min": 0.1,
    "platform_access_fee_pct": 0.1,
    "platform_access_fee_cpm": 0.1,
    "platform_access_fee_fixed": 0.1,
    "managed_service_fee_pct": 0.1,
    "managed_service_fee_cpm": 0.1,
    "managed_service_fee_fixed": 0.1,
    "optimization_fee_pct": 0.1,
    "optimization_fee_cpm": 0.1,
    "optimization_fee_fixed": 0.1,
    "pmp_optimization_off_unit": "PCT_TOTAL_COST",
    "pmp_optimization_off_fee_pct": 0.1,
    "pmp_optimization_off_fee_cpm": 0.1,
    "pmp_optimization_on_unit": "PCT_TOTAL_COST",
    "pmp_optimization_on_fee_pct": 0.1,
    "pmp_optimization_on_fee_cpm": 0.1,
    "dmp_fee_unit": "PCT_TOTAL_COST",
    "dmp_fee_pct": 0.1,
    "dmp_fee_cpm": 0.1,
    "dmp_fee_cpts": 0.1,
    "signals_fee_unit": "PCT_TOTAL_COST",
    "signals_fee_pct": 0.1,
    "signals_fee_cpm": 0.1,
    "t1_apps_fee_unit": "PCT_TOTAL_COST",
    "t1_apps_fee_pct": 0.1,
    "t1_apps_fee_cpm": 0.1,
    "spend_cap": 0.1,
    "platform_access_fee_unit": "PCT_TOTAL_COST",
    "managed_service_fee_unit": "PCT_TOTAL_COST",
    "optimization_fee_unit": "PCT_TOTAL_COST",
    "profit_share_fee_pct": 0.1,
    "exclude_agency_margin": false,
    "t1_as_fee_cpm": 0.05,
    "evidon_privacy_cost_cpm": 0.02,
    "peer39_channel_fee_cpm": 0.1,
    "peer39_custom_fee_cpm": 0.1,
    "peer39_safety_fee_cpm": 0.1,
    "peer39_quality_fee_cpm": 0.1,
    "fbx_dynamic_cpm": 0.3,
    "t1_vads_fee_cpm": 0.25,
    "adaptive_segment_cpm": 0,
    "external_media_tracking_cpm": 0,
    "currency_code": "str",
    "t1_html5_fee_cpm": 0.05,
    "viewability_display_sample": 0.1,
    "viewability_display_all_imps": 0.1,
    "viewability_video_sample": 0.1,
    "viewability_video_all_imps": 0.1,
    "standard_segment_cpm": 0.1,
    "connected_id_cost": 0,
    "financing_cost": 0,
    "audience_verification_cost": 0.25,
    "programmatic_guaranteed_platform_access_fee_cpm": 0.1,
    "programmatic_guaranteed_platform_access_fee_pct": 0.1,
    "programmatic_guaranteed_platform_access_fee_unit": "PCT_TOTAL_COST",
    "media_enablement_fee_cpm": 0.1,
    "media_enablement_fee_pct": 0.1,
    "media_enablement_fee_unit": "PCT_TOTAL_COST",
    "source_platform_access_fee_cpm": 0.1,
    "source_platform_access_fee_pct": 0.1,
    "source_platform_access_fee_unit": "PCT_TOTAL_COST",
    "country_tax_withholding_fee_cpm": 0.1,
    "country_tax_withholding_fee_pct": 0.1,
    "country_tax_withholding_fee_unit": "CPM",
    "partnership_rebate_fee_cpm": 0.1,
    "partnership_rebate_fee_pct": 0.1,
    "partnership_rebate_fee_unit": "CPM",
    "cross_device_fee_cpm": 0.1,
    "dba_optimization_fee_cpm": 0.1,
    "dba_optimization_fee_pct": 0.1,
    "dba_optimization_fee_unit": "CPM",
    "audio_video_platform_access_fee_cpm": 0.1,
    "audio_video_platform_access_fee_pct": 0.1,
    "audio_video_platform_access_fee_unit": "CPM"
  }'

Responses

Contract has been created successfully

Bodyapplication/json
dataobject(contract_base)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "organization_id": 0,
    "effective_start_date": "2019-08-24T14:15:22Z",
    "effective_end_date": "2019-08-24T14:15:22Z",
    "platform_monthly_min": 0.1,
    "platform_access_fee_pct": 0.1,
    "platform_access_fee_cpm": 0.1,
    "platform_access_fee_fixed": 0.1,
    "managed_service_fee_pct": 0.1,
    "managed_service_fee_cpm": 0.1,
    "managed_service_fee_fixed": 0.1,
    "optimization_fee_pct": 0.1,
    "optimization_fee_cpm": 0.1,
    "optimization_fee_fixed": 0.1,
    "pmp_optimization_off_unit": "PCT_TOTAL_COST",
    "pmp_optimization_off_fee_pct": 0.1,
    "pmp_optimization_off_fee_cpm": 0.1,
    "pmp_optimization_on_unit": "PCT_TOTAL_COST",
    "pmp_optimization_on_fee_pct": 0.1,
    "pmp_optimization_on_fee_cpm": 0.1,
    "dmp_fee_unit": "PCT_TOTAL_COST",
    "dmp_fee_pct": 0.1,
    "dmp_fee_cpm": 0.1,
    "dmp_fee_cpts": 0.1,
    "signals_fee_unit": "PCT_TOTAL_COST",
    "signals_fee_pct": 0.1,
    "signals_fee_cpm": 0.1,
    "t1_apps_fee_unit": "PCT_TOTAL_COST",
    "t1_apps_fee_pct": 0.1,
    "t1_apps_fee_cpm": 0.1,
    "contract_number": 0,
    "spend_cap": 0.1,
    "platform_access_fee_unit": "PCT_TOTAL_COST",
    "managed_service_fee_unit": "PCT_TOTAL_COST",
    "optimization_fee_unit": "PCT_TOTAL_COST",
    "profit_share_fee_pct": 0.1,
    "exclude_agency_margin": false,
    "t1_as_fee_cpm": 0.05,
    "evidon_privacy_cost_cpm": 0.02,
    "peer39_channel_fee_cpm": 0.1,
    "peer39_custom_fee_cpm": 0.1,
    "peer39_safety_fee_cpm": 0.1,
    "peer39_quality_fee_cpm": 0.1,
    "fbx_dynamic_cpm": 0.3,
    "t1_vads_fee_cpm": 0.25,
    "adaptive_segment_cpm": 0,
    "external_media_tracking_cpm": 0,
    "currency_code": "str",
    "t1_html5_fee_cpm": 0.05,
    "viewability_display_sample": 0.1,
    "viewability_display_all_imps": 0.1,
    "viewability_video_sample": 0.1,
    "viewability_video_all_imps": 0.1,
    "standard_segment_cpm": 0.1,
    "connected_id_cost": 0,
    "financing_cost": 0,
    "audience_verification_cost": 0.25,
    "programmatic_guaranteed_platform_access_fee_cpm": 0.1,
    "programmatic_guaranteed_platform_access_fee_pct": 0.1,
    "programmatic_guaranteed_platform_access_fee_unit": "PCT_TOTAL_COST",
    "media_enablement_fee_cpm": 0.1,
    "media_enablement_fee_pct": 0.1,
    "media_enablement_fee_unit": "PCT_TOTAL_COST",
    "source_platform_access_fee_cpm": 0.1,
    "source_platform_access_fee_pct": 0.1,
    "source_platform_access_fee_unit": "PCT_TOTAL_COST",
    "country_tax_withholding_fee_cpm": 0.1,
    "country_tax_withholding_fee_pct": 0.1,
    "country_tax_withholding_fee_unit": "CPM",
    "partnership_rebate_fee_cpm": 0.1,
    "partnership_rebate_fee_pct": 0.1,
    "partnership_rebate_fee_unit": "CPM",
    "cross_device_fee_cpm": 0.1,
    "dba_optimization_fee_cpm": 0.1,
    "dba_optimization_fee_pct": 0.1,
    "dba_optimization_fee_unit": "CPM",
    "audio_video_platform_access_fee_cpm": 0.1,
    "audio_video_platform_access_fee_pct": 0.1,
    "audio_video_platform_access_fee_unit": "CPM",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}

List Contracts

Request

Get a list of Contracts

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.
fullstring

Use this parameter to specify which properties to include in the response. To return all fields, set the value to *. For example, full=* will include all properties

Example: full=*
curl -i -X GET \
  'https://apidocs.mediamath.com/contracts?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>'

Responses

OK

Bodyapplication/json
Any of:
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"
  }
}

Update A Contract

Request

Update a Contract by its ID

Path
contract_idintegerrequired

Numeric ID of the contract to update

Bodyapplication/jsonrequired
idinteger
versioninteger
organization_idinteger
effective_start_datestring(date-time)
effective_end_datestring(date-time)
platform_monthly_minnumber(float)
platform_access_fee_pctnumber or null(float)
platform_access_fee_cpmnumber or null(float)
platform_access_fee_fixednumber or null(float)
managed_service_fee_pctnumber or null(float)
managed_service_fee_cpmnumber or null(float)
managed_service_fee_fixednumber or null(float)
optimization_fee_pctnumber or null(float)
optimization_fee_cpmnumber or null(float)
optimization_fee_fixednumber or null(float)
pmp_optimization_off_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"
pmp_optimization_off_fee_pctnumber or null(float)
pmp_optimization_off_fee_cpmnumber or null(float)
pmp_optimization_on_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"
pmp_optimization_on_fee_pctnumber or null(float)
pmp_optimization_on_fee_cpmnumber or null(float)
dmp_fee_unitstring or null
Enum"PCT_TOTAL_COST""CPM""CPTS"
dmp_fee_pctnumber or null(float)
dmp_fee_cpmnumber or null(float)
dmp_fee_cptsnumber or null(float)
signals_fee_unitstring or null
Enum"PCT_TOTAL_COST""CPM"
signals_fee_pctnumber or null(float)
signals_fee_cpmnumber or null(float)
t1_apps_fee_unitstring or null
Enum"PCT_TOTAL_COST""CPM"
t1_apps_fee_pctnumber or null(float)
t1_apps_fee_cpmnumber or null(float)
spend_capnumber or null(float)
platform_access_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"
managed_service_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"
optimization_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""FIXED""PCT_NET_TOTAL_SPEND"
profit_share_fee_pctnumber(float)
exclude_agency_marginboolean
Default false
t1_as_fee_cpmnumber(float)
Default 0.05
evidon_privacy_cost_cpmnumber(float)
Default 0.02
peer39_channel_fee_cpmnumber or null(float)
peer39_custom_fee_cpmnumber or null(float)
peer39_safety_fee_cpmnumber(float)
peer39_quality_fee_cpmnumber(float)
fbx_dynamic_cpmnumber(float)
Default 0.3
t1_vads_fee_cpmnumber(float)
Default 0.25
adaptive_segment_cpmnumber(float)
Default 0
external_media_tracking_cpmnumber(float)
Default 0
currency_codestring= 3 characters
t1_html5_fee_cpmnumber(float)
Default 0.05
viewability_display_samplenumber or null(float)
viewability_display_all_impsnumber or null(float)
viewability_video_samplenumber or null(float)
viewability_video_all_impsnumber or null(float)
standard_segment_cpmnumber(float)
Default 0.1
connected_id_costnumber(float)
Default 0
financing_costnumber(float)
Default 0
audience_verification_costnumber(float)
Default 0.25
programmatic_guaranteed_platform_access_fee_cpmnumber or null(float)
programmatic_guaranteed_platform_access_fee_pctnumber or null(float)
programmatic_guaranteed_platform_access_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_NET_TOTAL_SPEND"
media_enablement_fee_cpmnumber or null(float)
media_enablement_fee_pctnumber or null(float)
media_enablement_fee_unitstring
Enum"PCT_TOTAL_COST""CPM""PCT_CLEAR"
source_platform_access_fee_cpmnumber or null(float)
source_platform_access_fee_pctnumber or null(float)
source_platform_access_fee_unitstring
Enum"PCT_TOTAL_COST""CPM"
country_tax_withholding_fee_cpmnumber or null(float)
country_tax_withholding_fee_pctnumber or null(float)
country_tax_withholding_fee_unitstring
Enum"CPM""PCT_CLEAR""PCT_NET_TOTAL_SPEND"
partnership_rebate_fee_cpmnumber or null(float)
partnership_rebate_fee_pctnumber or null(float)
partnership_rebate_fee_unitstring
Enum"CPM""PCT_CLEAR""PCT_NET_TOTAL_SPEND"
cross_device_fee_cpmnumber or null(float)
dba_optimization_fee_cpmnumber or null(float)
dba_optimization_fee_pctnumber or null(float)
dba_optimization_fee_unitstring
Enum"CPM""PCT_MEDIA"
audio_video_platform_access_fee_cpmnumber or null(float)
audio_video_platform_access_fee_pctnumber or null(float)
audio_video_platform_access_fee_unitstring
Enum"CPM""PCT_TOTAL_COST"
curl -i -X POST \
  'https://apidocs.mediamath.com/contracts/{contract_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "version": 0,
    "organization_id": 0,
    "effective_start_date": "2019-08-24T14:15:22Z",
    "effective_end_date": "2019-08-24T14:15:22Z",
    "platform_monthly_min": 0.1,
    "platform_access_fee_pct": 0.1,
    "platform_access_fee_cpm": 0.1,
    "platform_access_fee_fixed": 0.1,
    "managed_service_fee_pct": 0.1,
    "managed_service_fee_cpm": 0.1,
    "managed_service_fee_fixed": 0.1,
    "optimization_fee_pct": 0.1,
    "optimization_fee_cpm": 0.1,
    "optimization_fee_fixed": 0.1,
    "pmp_optimization_off_unit": "PCT_TOTAL_COST",
    "pmp_optimization_off_fee_pct": 0.1,
    "pmp_optimization_off_fee_cpm": 0.1,
    "pmp_optimization_on_unit": "PCT_TOTAL_COST",
    "pmp_optimization_on_fee_pct": 0.1,
    "pmp_optimization_on_fee_cpm": 0.1,
    "dmp_fee_unit": "PCT_TOTAL_COST",
    "dmp_fee_pct": 0.1,
    "dmp_fee_cpm": 0.1,
    "dmp_fee_cpts": 0.1,
    "signals_fee_unit": "PCT_TOTAL_COST",
    "signals_fee_pct": 0.1,
    "signals_fee_cpm": 0.1,
    "t1_apps_fee_unit": "PCT_TOTAL_COST",
    "t1_apps_fee_pct": 0.1,
    "t1_apps_fee_cpm": 0.1,
    "spend_cap": 0.1,
    "platform_access_fee_unit": "PCT_TOTAL_COST",
    "managed_service_fee_unit": "PCT_TOTAL_COST",
    "optimization_fee_unit": "PCT_TOTAL_COST",
    "profit_share_fee_pct": 0.1,
    "exclude_agency_margin": false,
    "t1_as_fee_cpm": 0.05,
    "evidon_privacy_cost_cpm": 0.02,
    "peer39_channel_fee_cpm": 0.1,
    "peer39_custom_fee_cpm": 0.1,
    "peer39_safety_fee_cpm": 0.1,
    "peer39_quality_fee_cpm": 0.1,
    "fbx_dynamic_cpm": 0.3,
    "t1_vads_fee_cpm": 0.25,
    "adaptive_segment_cpm": 0,
    "external_media_tracking_cpm": 0,
    "currency_code": "str",
    "t1_html5_fee_cpm": 0.05,
    "viewability_display_sample": 0.1,
    "viewability_display_all_imps": 0.1,
    "viewability_video_sample": 0.1,
    "viewability_video_all_imps": 0.1,
    "standard_segment_cpm": 0.1,
    "connected_id_cost": 0,
    "financing_cost": 0,
    "audience_verification_cost": 0.25,
    "programmatic_guaranteed_platform_access_fee_cpm": 0.1,
    "programmatic_guaranteed_platform_access_fee_pct": 0.1,
    "programmatic_guaranteed_platform_access_fee_unit": "PCT_TOTAL_COST",
    "media_enablement_fee_cpm": 0.1,
    "media_enablement_fee_pct": 0.1,
    "media_enablement_fee_unit": "PCT_TOTAL_COST",
    "source_platform_access_fee_cpm": 0.1,
    "source_platform_access_fee_pct": 0.1,
    "source_platform_access_fee_unit": "PCT_TOTAL_COST",
    "country_tax_withholding_fee_cpm": 0.1,
    "country_tax_withholding_fee_pct": 0.1,
    "country_tax_withholding_fee_unit": "CPM",
    "partnership_rebate_fee_cpm": 0.1,
    "partnership_rebate_fee_pct": 0.1,
    "partnership_rebate_fee_unit": "CPM",
    "cross_device_fee_cpm": 0.1,
    "dba_optimization_fee_cpm": 0.1,
    "dba_optimization_fee_pct": 0.1,
    "dba_optimization_fee_unit": "CPM",
    "audio_video_platform_access_fee_cpm": 0.1,
    "audio_video_platform_access_fee_pct": 0.1,
    "audio_video_platform_access_fee_unit": "CPM"
  }'

Responses

Contract has been updated successfully

Bodyapplication/json
dataobject(contract_base)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "organization_id": 0,
    "effective_start_date": "2019-08-24T14:15:22Z",
    "effective_end_date": "2019-08-24T14:15:22Z",
    "platform_monthly_min": 0.1,
    "platform_access_fee_pct": 0.1,
    "platform_access_fee_cpm": 0.1,
    "platform_access_fee_fixed": 0.1,
    "managed_service_fee_pct": 0.1,
    "managed_service_fee_cpm": 0.1,
    "managed_service_fee_fixed": 0.1,
    "optimization_fee_pct": 0.1,
    "optimization_fee_cpm": 0.1,
    "optimization_fee_fixed": 0.1,
    "pmp_optimization_off_unit": "PCT_TOTAL_COST",
    "pmp_optimization_off_fee_pct": 0.1,
    "pmp_optimization_off_fee_cpm": 0.1,
    "pmp_optimization_on_unit": "PCT_TOTAL_COST",
    "pmp_optimization_on_fee_pct": 0.1,
    "pmp_optimization_on_fee_cpm": 0.1,
    "dmp_fee_unit": "PCT_TOTAL_COST",
    "dmp_fee_pct": 0.1,
    "dmp_fee_cpm": 0.1,
    "dmp_fee_cpts": 0.1,
    "signals_fee_unit": "PCT_TOTAL_COST",
    "signals_fee_pct": 0.1,
    "signals_fee_cpm": 0.1,
    "t1_apps_fee_unit": "PCT_TOTAL_COST",
    "t1_apps_fee_pct": 0.1,
    "t1_apps_fee_cpm": 0.1,
    "contract_number": 0,
    "spend_cap": 0.1,
    "platform_access_fee_unit": "PCT_TOTAL_COST",
    "managed_service_fee_unit": "PCT_TOTAL_COST",
    "optimization_fee_unit": "PCT_TOTAL_COST",
    "profit_share_fee_pct": 0.1,
    "exclude_agency_margin": false,
    "t1_as_fee_cpm": 0.05,
    "evidon_privacy_cost_cpm": 0.02,
    "peer39_channel_fee_cpm": 0.1,
    "peer39_custom_fee_cpm": 0.1,
    "peer39_safety_fee_cpm": 0.1,
    "peer39_quality_fee_cpm": 0.1,
    "fbx_dynamic_cpm": 0.3,
    "t1_vads_fee_cpm": 0.25,
    "adaptive_segment_cpm": 0,
    "external_media_tracking_cpm": 0,
    "currency_code": "str",
    "t1_html5_fee_cpm": 0.05,
    "viewability_display_sample": 0.1,
    "viewability_display_all_imps": 0.1,
    "viewability_video_sample": 0.1,
    "viewability_video_all_imps": 0.1,
    "standard_segment_cpm": 0.1,
    "connected_id_cost": 0,
    "financing_cost": 0,
    "audience_verification_cost": 0.25,
    "programmatic_guaranteed_platform_access_fee_cpm": 0.1,
    "programmatic_guaranteed_platform_access_fee_pct": 0.1,
    "programmatic_guaranteed_platform_access_fee_unit": "PCT_TOTAL_COST",
    "media_enablement_fee_cpm": 0.1,
    "media_enablement_fee_pct": 0.1,
    "media_enablement_fee_unit": "PCT_TOTAL_COST",
    "source_platform_access_fee_cpm": 0.1,
    "source_platform_access_fee_pct": 0.1,
    "source_platform_access_fee_unit": "PCT_TOTAL_COST",
    "country_tax_withholding_fee_cpm": 0.1,
    "country_tax_withholding_fee_pct": 0.1,
    "country_tax_withholding_fee_unit": "CPM",
    "partnership_rebate_fee_cpm": 0.1,
    "partnership_rebate_fee_pct": 0.1,
    "partnership_rebate_fee_unit": "CPM",
    "cross_device_fee_cpm": 0.1,
    "dba_optimization_fee_cpm": 0.1,
    "dba_optimization_fee_pct": 0.1,
    "dba_optimization_fee_unit": "CPM",
    "audio_video_platform_access_fee_cpm": 0.1,
    "audio_video_platform_access_fee_pct": 0.1,
    "audio_video_platform_access_fee_unit": "CPM",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}

Get a Contract

Request

Get a Contract by its ID

Path
contract_idintegerrequired

Numeric ID of the contract to get

curl -i -X GET \
  'https://apidocs.mediamath.com/contracts/{contract_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Contract GET

Bodyapplication/json
dataobject(contract_base)
metaobject
Response
application/json
{
  "data": {
    "id": 0,
    "version": 0,
    "organization_id": 0,
    "effective_start_date": "2019-08-24T14:15:22Z",
    "effective_end_date": "2019-08-24T14:15:22Z",
    "platform_monthly_min": 0.1,
    "platform_access_fee_pct": 0.1,
    "platform_access_fee_cpm": 0.1,
    "platform_access_fee_fixed": 0.1,
    "managed_service_fee_pct": 0.1,
    "managed_service_fee_cpm": 0.1,
    "managed_service_fee_fixed": 0.1,
    "optimization_fee_pct": 0.1,
    "optimization_fee_cpm": 0.1,
    "optimization_fee_fixed": 0.1,
    "pmp_optimization_off_unit": "PCT_TOTAL_COST",
    "pmp_optimization_off_fee_pct": 0.1,
    "pmp_optimization_off_fee_cpm": 0.1,
    "pmp_optimization_on_unit": "PCT_TOTAL_COST",
    "pmp_optimization_on_fee_pct": 0.1,
    "pmp_optimization_on_fee_cpm": 0.1,
    "dmp_fee_unit": "PCT_TOTAL_COST",
    "dmp_fee_pct": 0.1,
    "dmp_fee_cpm": 0.1,
    "dmp_fee_cpts": 0.1,
    "signals_fee_unit": "PCT_TOTAL_COST",
    "signals_fee_pct": 0.1,
    "signals_fee_cpm": 0.1,
    "t1_apps_fee_unit": "PCT_TOTAL_COST",
    "t1_apps_fee_pct": 0.1,
    "t1_apps_fee_cpm": 0.1,
    "contract_number": 0,
    "spend_cap": 0.1,
    "platform_access_fee_unit": "PCT_TOTAL_COST",
    "managed_service_fee_unit": "PCT_TOTAL_COST",
    "optimization_fee_unit": "PCT_TOTAL_COST",
    "profit_share_fee_pct": 0.1,
    "exclude_agency_margin": false,
    "t1_as_fee_cpm": 0.05,
    "evidon_privacy_cost_cpm": 0.02,
    "peer39_channel_fee_cpm": 0.1,
    "peer39_custom_fee_cpm": 0.1,
    "peer39_safety_fee_cpm": 0.1,
    "peer39_quality_fee_cpm": 0.1,
    "fbx_dynamic_cpm": 0.3,
    "t1_vads_fee_cpm": 0.25,
    "adaptive_segment_cpm": 0,
    "external_media_tracking_cpm": 0,
    "currency_code": "str",
    "t1_html5_fee_cpm": 0.05,
    "viewability_display_sample": 0.1,
    "viewability_display_all_imps": 0.1,
    "viewability_video_sample": 0.1,
    "viewability_video_all_imps": 0.1,
    "standard_segment_cpm": 0.1,
    "connected_id_cost": 0,
    "financing_cost": 0,
    "audience_verification_cost": 0.25,
    "programmatic_guaranteed_platform_access_fee_cpm": 0.1,
    "programmatic_guaranteed_platform_access_fee_pct": 0.1,
    "programmatic_guaranteed_platform_access_fee_unit": "PCT_TOTAL_COST",
    "media_enablement_fee_cpm": 0.1,
    "media_enablement_fee_pct": 0.1,
    "media_enablement_fee_unit": "PCT_TOTAL_COST",
    "source_platform_access_fee_cpm": 0.1,
    "source_platform_access_fee_pct": 0.1,
    "source_platform_access_fee_unit": "PCT_TOTAL_COST",
    "country_tax_withholding_fee_cpm": 0.1,
    "country_tax_withholding_fee_pct": 0.1,
    "country_tax_withholding_fee_unit": "CPM",
    "partnership_rebate_fee_cpm": 0.1,
    "partnership_rebate_fee_pct": 0.1,
    "partnership_rebate_fee_unit": "CPM",
    "cross_device_fee_cpm": 0.1,
    "dba_optimization_fee_cpm": 0.1,
    "dba_optimization_fee_pct": 0.1,
    "dba_optimization_fee_unit": "CPM",
    "audio_video_platform_access_fee_cpm": 0.1,
    "audio_video_platform_access_fee_pct": 0.1,
    "audio_video_platform_access_fee_unit": "CPM",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "status": "success"
  }
}

List Organization Settings

Operations

Update Organization Settings

Operations

New Strategy Plans

Operations

Strategy Plan Target Values

Operations

Campaigns Budget Flights

Operations

User Settings

Operations

Update User Settings

Operations

Healthcheck for Atomic Creatives

Request

Endpoint to check the health of atomic creatives by ID(s).

Query
qstringrequired

Query parameter to specify the atomic creative ID(s). Format:

  • For multiple IDs: atomic_creative_id==(id1, id2)
  • For a single ID: atomic_creative_id==id
Examples:
q=atomic_creative_id==11884513
q=atomic_creative_id==(11884513, 11884508)
curl -i -X GET \
  'https://apidocs.mediamath.com/atomic_creatives/healthcheck?q=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Healthcheck successful

Response
No content

Verticals

Operations

Audience Vendors

Operations

Supply Sources

Operations

Vendors

Operations

Ad Servers

Operations

Site Lists Site Download

Operations

Site Lists Assignments

Operations

Targeting Segment Objectives

Operations

Targeting Segment Objective

Operations

Contract

Operations