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

Campaigns Budget Flights

Campaigns Budget Flights

Operations

Campaign Plans

Campaign Plans

Operations

Strategies

Strategies

Operations

Create a Strategy

Request

Create a strategy

Security
Auth0
Query
extendedboolean

Get extended properties in response

Bodyapplication/jsonrequired
campaign_idintegerrequired
namestring<= 128 charactersrequired
media_typestringrequired
Enum"DISPLAY""VIDEO"
goalsobjectrequired
goals.​goal_typestring
Enum"spend""reach""cpc""cpe""cpa""roi""ctr""vcr""viewability_rate""vcpm"
goals.​goal_valuenumber(float)( 0 .. 999999999.9999 ]required
goals.​min_bidnumber(float)[ 0 .. 9999999.99 ]
goals.​max_bidnumber(float)[ 0.01 .. 9999999.99 ]
goals.​roi_targetnumber or null(double)[ 0 .. 999999999.99 ]
goals.​bid_min_devicesinteger or null
goals.​bid_aggressivenessinteger[ 0 .. 100 ]
goals.​bid_price_is_media_onlyboolean
goals.​max_bid_wmnumber or null(float)[ 0 .. 9999999.99 ]
goals.​use_bid_shadingboolean
goals.​flat_rate_cpmnumber or null(float)[ 0.01 .. 9999999.99 ]
durationobjectrequired

Duration of strategy must not exceed 36 months

duration.​use_campaign_startboolean
duration.​use_campaign_endboolean
duration.​start_datestring or null(date-time)
duration.​end_datestring or null(date-time)
descriptionstring<= 1024 characters
statusboolean
archivedboolean
Default false
is_programmatic_guaranteedboolean
Default false
use_optimizationboolean
ads_txt_verifiedstring or null
Enum"ANY""AUTHORIZED_ONLY""AUTHORIZED_DIRECT_ONLY""NONE"""
typestring
Enum"REM""GBO""AUD"
feature_compatibilitystring or null<= 1024 characters
device_graph_onlyboolean
mfa_avoidancestring
Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
inherited_mfa_avoidancestring
Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
inherited_mfa_fromstring
Enum"Organization""Agency""Advertiser""Campaign""Strategy"
idinteger
versioninteger
budgetobject(strategy_budget)
pacingobject(strategy_pacing)
frequencyobject(strategy_frequency)
inventoryobject(strategy_inventory)
targetingobject(strategy_targeting)
conceptsobject(strategy_concepts_extended)
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/strategies?extended=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_id": 0,
    "name": "string",
    "media_type": "DISPLAY",
    "goals": {
      "goal_type": "spend",
      "goal_value": 0,
      "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,
      "flat_rate_cpm": 0.01
    },
    "duration": {
      "use_campaign_start": true,
      "use_campaign_end": true,
      "start_date": "2019-08-24T14:15:22Z",
      "end_date": "2019-08-24T14:15:22Z"
    },
    "description": "string",
    "status": true,
    "archived": false,
    "is_programmatic_guaranteed": false,
    "use_optimization": true,
    "ads_txt_verified": "ANY",
    "type": "REM",
    "feature_compatibility": "string",
    "device_graph_only": true,
    "mfa_avoidance": "INHERIT",
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "id": 0,
    "version": 0,
    "budget": {
      "budget": 0.1,
      "currency_code": "string",
      "margin_pct": 9999999.9999
    },
    "pacing": {
      "impression_pacing_type": "even",
      "impression_pacing_amount": 1,
      "impression_pacing_interval": "hour",
      "pacing_type": "even",
      "pacing_amount": 9999999.99,
      "pacing_interval": "hour",
      "pacing_optimization_type": "monetary",
      "pacing_optimization_amount": 9999999.99,
      "use_dba_strategy_pacing": "always",
      "use_dba_strategy_pacing_after_date": "2019-08-24"
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 0,
      "frequency_optimization": true
    },
    "inventory": {
      "supply_type": "RTB",
      "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
        }
      ],
      "campaign_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
            }
          ]
        }
      },
      "audience_groups": {
        "include": [
          {
            "operator": "AND",
            "segment_groups": [
              {
                "segment_group_id": 0
              }
            ]
          }
        ],
        "exclude": {}
      },
      "contextual_groups": {
        "include": [
          {
            "operator": "AND",
            "segment_groups": [
              {
                "segment_group_id": 0
              }
            ]
          }
        ],
        "exclude": {}
      },
      "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": "AND",
            "target_value_id": 0,
            "code": "DMAX"
          }
        ],
        "exclude": [
          {
            "operator": "AND",
            "target_value_id": 0,
            "code": "DMAX"
          }
        ]
      },
      "technology": {
        "include": [
          {
            "operator": "AND",
            "code": "BSER",
            "target_value_id": 0
          }
        ],
        "exclude": [
          {
            "operator": "AND",
            "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"
        }
      ]
    },
    "concepts": {
      "weighting": "NONE",
      "creative_groups": [
        {
          "concept_id": 0,
          "percent": 0
        }
      ]
    }
  }'

Responses

Strategy created response

Bodyapplication/json
Any of:
dataobject
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "mfa_avoidance": "INHERIT",
    "campaign_name": "string",
    "campaign_start_date": "2019-08-24T14:15:22Z",
    "campaign_end_date": "2019-08-24T14:15:22Z",
    "campaign_zone_name": "string",
    "campaign_service_type": "string",
    "campaign_goal_type": "string",
    "campaign_goal_value": 0.1,
    "campaign_merit_pixel_id": 0,
    "viewability": { … },
    "name": "string",
    "description": "string",
    "status": true,
    "archived": false,
    "is_programmatic_guaranteed": false,
    "media_type": "DISPLAY",
    "use_optimization": true,
    "ads_txt_verified": "ANY",
    "type": "REM",
    "feature_compatibility": "string",
    "device_graph_only": true,
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "id": 0,
    "version": 0,
    "campaign_id": 0,
    "zone_name": "America/New_York",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "duration": { … },
    "budget": { … },
    "pacing": { … },
    "goals": { … },
    "frequency": { … },
    "inventory": { … },
    "targeting": { … },
    "concepts": { … }
  },
  "meta": {
    "status": "success"
  }
}

List Strategies

Request

Get a list of strategies

Security
Auth0
Query
withstring

Get related property in response

Enum"technology""location""ip_addresses""geofences""my_data""audience""contextual""deals""site_lists""supply"
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.
extendedboolean

Get extended properties in response

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/strategies?with=technology&page_limit=100&page_offset=0&sort_by=id%2C+-id%2C+name%2C+-name&q=string&extended=true&full=*' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List strategies 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"
  }
}

Update a Strategy

Request

Update as strategy by ID

Security
Auth0
Path
strategy_idintegerrequired

Numeric ID of the strategy to update

Query
extendedboolean

Get extended properties in response

Bodyapplication/jsonrequired
namestring<= 128 characters
descriptionstring<= 1024 characters
statusboolean
archivedboolean
Default false
is_programmatic_guaranteedboolean
Default false
media_typestring
Enum"DISPLAY""VIDEO"
use_optimizationboolean
ads_txt_verifiedstring or null
Enum"ANY""AUTHORIZED_ONLY""AUTHORIZED_DIRECT_ONLY""NONE"""
typestring
Enum"REM""GBO""AUD"
feature_compatibilitystring or null<= 1024 characters
device_graph_onlyboolean
mfa_avoidancestring
Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
inherited_mfa_avoidancestring
Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"
inherited_mfa_fromstring
Enum"Organization""Agency""Advertiser""Campaign""Strategy"
idinteger
versioninteger
campaign_idinteger
durationobject(strategy_duration)

Duration of strategy must not exceed 36 months

budgetobject(strategy_budget)
pacingobject(strategy_pacing)
goalsobject(strategy_goals)
frequencyobject(strategy_frequency)
inventoryobject(strategy_inventory)
targetingobject(strategy_targeting)
conceptsobject(strategy_concepts_extended)
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/strategies/{strategy_id}?extended=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "status": true,
    "archived": false,
    "is_programmatic_guaranteed": false,
    "media_type": "DISPLAY",
    "use_optimization": true,
    "ads_txt_verified": "ANY",
    "type": "REM",
    "feature_compatibility": "string",
    "device_graph_only": true,
    "mfa_avoidance": "INHERIT",
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "id": 0,
    "version": 0,
    "campaign_id": 0,
    "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",
      "margin_pct": 9999999.9999
    },
    "pacing": {
      "impression_pacing_type": "even",
      "impression_pacing_amount": 1,
      "impression_pacing_interval": "hour",
      "pacing_type": "even",
      "pacing_amount": 9999999.99,
      "pacing_interval": "hour",
      "pacing_optimization_type": "monetary",
      "pacing_optimization_amount": 9999999.99,
      "use_dba_strategy_pacing": "always",
      "use_dba_strategy_pacing_after_date": "2019-08-24"
    },
    "goals": {
      "goal_type": "spend",
      "goal_value": 0,
      "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,
      "flat_rate_cpm": 0.01
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 0,
      "frequency_optimization": true
    },
    "inventory": {
      "supply_type": "RTB",
      "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
        }
      ],
      "campaign_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
            }
          ]
        }
      },
      "audience_groups": {
        "include": [
          {
            "operator": "AND",
            "segment_groups": [
              {
                "segment_group_id": 0
              }
            ]
          }
        ],
        "exclude": {}
      },
      "contextual_groups": {
        "include": [
          {
            "operator": "AND",
            "segment_groups": [
              {
                "segment_group_id": 0
              }
            ]
          }
        ],
        "exclude": {}
      },
      "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": "AND",
            "target_value_id": 0,
            "code": "DMAX"
          }
        ],
        "exclude": [
          {
            "operator": "AND",
            "target_value_id": 0,
            "code": "DMAX"
          }
        ]
      },
      "technology": {
        "include": [
          {
            "operator": "AND",
            "code": "BSER",
            "target_value_id": 0
          }
        ],
        "exclude": [
          {
            "operator": "AND",
            "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"
        }
      ]
    },
    "concepts": {
      "weighting": "NONE",
      "creative_groups": [
        {
          "concept_id": 0,
          "percent": 0
        }
      ]
    }
  }'

Responses

Strategy updated response

Bodyapplication/json
Any of:
dataobject
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "mfa_avoidance": "INHERIT",
    "campaign_name": "string",
    "campaign_start_date": "2019-08-24T14:15:22Z",
    "campaign_end_date": "2019-08-24T14:15:22Z",
    "campaign_zone_name": "string",
    "campaign_service_type": "string",
    "campaign_goal_type": "string",
    "campaign_goal_value": 0.1,
    "campaign_merit_pixel_id": 0,
    "viewability": { … },
    "name": "string",
    "description": "string",
    "status": true,
    "archived": false,
    "is_programmatic_guaranteed": false,
    "media_type": "DISPLAY",
    "use_optimization": true,
    "ads_txt_verified": "ANY",
    "type": "REM",
    "feature_compatibility": "string",
    "device_graph_only": true,
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "id": 0,
    "version": 0,
    "campaign_id": 0,
    "zone_name": "America/New_York",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "duration": { … },
    "budget": { … },
    "pacing": { … },
    "goals": { … },
    "frequency": { … },
    "inventory": { … },
    "targeting": { … },
    "concepts": { … }
  },
  "meta": {
    "status": "success"
  }
}

Get a Strategy

Request

Get a strategy by ID

Security
Auth0
Path
strategy_idintegerrequired

Numeric ID of the strategy object to get

Query
extendedboolean

Get extended properties in response

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

Responses

Strategy response

Bodyapplication/json
Any of:
dataobject
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "mfa_avoidance": "INHERIT",
    "campaign_name": "string",
    "campaign_start_date": "2019-08-24T14:15:22Z",
    "campaign_end_date": "2019-08-24T14:15:22Z",
    "campaign_zone_name": "string",
    "campaign_service_type": "string",
    "campaign_goal_type": "string",
    "campaign_goal_value": 0.1,
    "campaign_merit_pixel_id": 0,
    "viewability": { … },
    "name": "string",
    "description": "string",
    "status": true,
    "archived": false,
    "is_programmatic_guaranteed": false,
    "media_type": "DISPLAY",
    "use_optimization": true,
    "ads_txt_verified": "ANY",
    "type": "REM",
    "feature_compatibility": "string",
    "device_graph_only": true,
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "id": 0,
    "version": 0,
    "campaign_id": 0,
    "zone_name": "America/New_York",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "duration": { … },
    "budget": { … },
    "pacing": { … },
    "goals": { … },
    "frequency": { … },
    "inventory": { … },
    "targeting": { … },
    "concepts": { … }
  },
  "meta": {
    "status": "success"
  }
}

Copy a strategy

Request

Copy a strategy

Security
Auth0
Path
strategy_idintegerrequired

Numeric ID of the strategy object

Bodyapplication/jsonrequired
statusbooleanrequired

Indicates the status.

namestringrequired

Name of the entity.

durationobject
targetingobject
inventoryobject
conceptsobject
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/strategies/{strategy_id}/copy' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": true,
    "name": "string",
    "duration": {
      "start_date": "2019-08-24T14:15:22Z",
      "copy_use_campaign_start": true,
      "end_date": "2019-08-24T14:15:22Z",
      "copy_use_campaign_end": true
    },
    "targeting": {
      "copy_geofence": true,
      "copy_contextual": true,
      "copy_audience": true,
      "copy_technology": true,
      "copy_my_data": true,
      "copy_location": true,
      "copy_day_parts": true,
      "copy_postal_codes": true,
      "copy_audio_video": true,
      "copy_ip_addresses": true,
      "copy_fold_position": true
    },
    "inventory": {
      "copy_supply": true,
      "copy_site_lists": true,
      "copy_supply_controls": true
    },
    "concepts": {
      "copy_creative_groups": true
    }
  }'

Responses

Strategy copy

Bodyapplication/json
dataobject
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "mfa_avoidance": "INHERIT",
    "campaign_name": "string",
    "campaign_start_date": "2019-08-24T14:15:22Z",
    "campaign_end_date": "2019-08-24T14:15:22Z",
    "campaign_zone_name": "string",
    "campaign_service_type": "string",
    "campaign_goal_type": "string",
    "campaign_goal_value": 0.1,
    "campaign_merit_pixel_id": 0,
    "viewability": { … },
    "name": "string",
    "description": "string",
    "status": true,
    "archived": false,
    "is_programmatic_guaranteed": false,
    "media_type": "DISPLAY",
    "use_optimization": true,
    "ads_txt_verified": "ANY",
    "type": "REM",
    "feature_compatibility": "string",
    "device_graph_only": true,
    "inherited_mfa_avoidance": "INHERIT",
    "inherited_mfa_from": "Organization",
    "id": 0,
    "version": 0,
    "campaign_id": 0,
    "zone_name": "America/New_York",
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "duration": { … },
    "budget": { … },
    "pacing": { … },
    "goals": { … },
    "frequency": { … },
    "inventory": { … },
    "targeting": { … },
    "concepts": { … }
  },
  "meta": {
    "status": "success"
  }
}

Get Targeting Friendly Names

Request

Get targeting friendly names

Security
Auth0
Path
strategy_idintegerrequired

Numeric ID of the strategy object

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/strategies/{strategy_id}/friendly_names' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Strategy friendly names response

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

Get Forecast Query

Request

Get forecast query

Security
Auth0
Path
strategy_idintegerrequired

Numeric ID of the strategy object

curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/strategies/{strategy_id}/forecast_query' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Strategy forecast query response

Bodyapplication/json
dataobject(strategy_forecast_query)
metaobject(single_metadata)
Response
application/json
{
  "data": {
    "expression": "string",
    "freqCap": 0,
    "freqDur": "hour",
    "maxSpend": 0.1,
    "maxCPM": 0.1
  },
  "meta": {
    "status": "success"
  }
}

Strategy Audit Log

Request

Get a list changes to this strategy

Security
Auth0
Path
strategy_idintegerrequired

Numeric ID of the strategy

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/strategies/{strategy_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"
  }
}

Bulk Update Strategies

Request

Update multiple strategies

Security
Auth0
Bodyapplication/json
updateArray of objects
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/bulk_update/strategies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "update": [
      {
        "id": 0,
        "name": "string",
        "description": "string",
        "status": true,
        "archived": false,
        "is_programmatic_guaranteed": false,
        "media_type": "DISPLAY",
        "use_optimization": true,
        "ads_txt_verified": "ANY",
        "type": "REM",
        "feature_compatibility": "string",
        "device_graph_only": true,
        "mfa_avoidance": "INHERIT",
        "inherited_mfa_avoidance": "INHERIT",
        "inherited_mfa_from": "Organization",
        "version": 0,
        "campaign_id": 0,
        "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",
          "margin_pct": 9999999.9999
        },
        "pacing": {
          "impression_pacing_type": "even",
          "impression_pacing_amount": 1,
          "impression_pacing_interval": "hour",
          "pacing_type": "even",
          "pacing_amount": 9999999.99,
          "pacing_interval": "hour",
          "pacing_optimization_type": "monetary",
          "pacing_optimization_amount": 9999999.99,
          "use_dba_strategy_pacing": "always",
          "use_dba_strategy_pacing_after_date": "2019-08-24"
        },
        "goals": {
          "goal_type": "spend",
          "goal_value": 0,
          "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,
          "flat_rate_cpm": 0.01
        },
        "frequency": {
          "frequency_type": "even",
          "frequency_interval": "hour",
          "frequency_amount": 0,
          "frequency_optimization": true
        },
        "inventory": {
          "supply_type": "RTB",
          "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
            }
          ],
          "campaign_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": [
                  null
                ]
              }
            ],
            "exclude": {
              "operator": "AND",
              "segments": [
                {}
              ]
            }
          },
          "contextual": {
            "include": [
              {
                "code": "string",
                "operator": "AND",
                "segments": [
                  null
                ]
              }
            ],
            "exclude": {
              "code": "string",
              "operator": "AND",
              "segments": [
                {}
              ]
            }
          },
          "audience_groups": {
            "include": [
              {
                "operator": "AND",
                "segment_groups": [
                  {}
                ]
              }
            ],
            "exclude": {}
          },
          "contextual_groups": {
            "include": [
              {
                "operator": "AND",
                "segment_groups": [
                  {}
                ]
              }
            ],
            "exclude": {}
          },
          "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": [
                {}
              ]
            },
            "exclude": {
              "operator": "AND",
              "segments": [
                {}
              ]
            }
          },
          "my_data": {
            "include": {
              "operator": "AND",
              "pixels": [
                {}
              ]
            },
            "exclude": {
              "operator": "AND",
              "pixels": [
                {}
              ]
            }
          },
          "location": {
            "include": [
              {
                "operator": "AND",
                "target_value_id": 0,
                "code": "DMAX"
              }
            ],
            "exclude": [
              {
                "operator": "AND",
                "target_value_id": 0,
                "code": "DMAX"
              }
            ]
          },
          "technology": {
            "include": [
              {
                "operator": "AND",
                "code": "BSER",
                "target_value_id": 0
              }
            ],
            "exclude": [
              {
                "operator": "AND",
                "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"
            }
          ]
        },
        "concepts": {
          "weighting": "NONE",
          "creative_groups": [
            {
              "concept_id": 0,
              "percent": 0
            }
          ]
        }
      }
    ]
  }'

Responses

strategies bulk update response

Bodyapplication/json
dataArray of objects(strategy_full)
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 Strategy

Request

List user permissions for a strategy

Security
Auth0
Path
strategy_idintegerrequired

Numeric ID of the strategy

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.
curl -i -X GET \
  'https://api.mediamath.com/api/v3.0/strategies/{strategy_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_strategy)
metaobject(pagination metadata)
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Bulk Strategy Audit Log

Request

Get a list of changes to these strategies

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 integersnon-emptyrequired
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/audit_log/strategies?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": [
      0
    ]
  }'

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

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