Skip to content
New Strategy Plans
/
Run and Update Forecast for Given New Strategy Plan

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

Strategy Parameters

Strategy Parameters

Operations

Strategy Templates

Strategy Templates

Operations

New Strategy Plans

New Strategy Plans

Operations

Post Ephemeral New Strategy Plan to Run a Forecast

Request

Post a new strategy plan object to run forecast without saving the strategy plan

Security
Auth0
Bodyapplication/jsonrequired
advertiser_idinteger
campaign_plan_idinteger
channelsArray of strings
namestring<= 128 characters
feature_compatibilitystring<= 1024 characters
device_graph_onlyboolean
idinteger
versioninteger
campaign_idinteger
zone_namestring
Example: "America/New_York"
campaign_service_typestring
typestring
durationobject(strategy_plan_duration)
budgetobject(strategy_plan_budget)
goalsobject(strategy_plan_goals)
frequencyobject(strategy_plan_frequency)
inventoryobject(strategy_plan_inventory)
targetingobject(strategy_plan_targeting)
creativesobject(strategy_plan_creatives)
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/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": "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"
        }
      ]
    },
    "creatives": {
      "ad_expandable": true,
      "ad_formats": [
        "string"
      ],
      "ad_sizes": [
        "string"
      ]
    }
  }'

Responses

New strategy plan response

Bodyapplication/json
dataobject

New Strategy Plan

metaobject
Response
application/json
{
  "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"
  }
}

Run and Update Forecast for Given New Strategy Plan

Request

Run and update forecast for given new strategy plan ID

Security
Auth0
Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to run a forecast

curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/new_strategy_plans/{strategy_plan_id}/forecast' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

New strategy plan response

Bodyapplication/json
dataobject

New Strategy Plan

metaobject
Response
application/json
{
  "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"
  }
}

Get a New Strategy Plan

Request

Get a new strategy plan by ID

Security
Auth0
Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to get

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

Responses

New strategy plan response

Bodyapplication/json
dataobject

New Strategy Plan

metaobject
Response
application/json
{
  "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"
  }
}

Update a New Strategy Plan

Request

Update a new strategy plan by ID

Security
Auth0
Path
strategy_plan_idintegerrequired

Numeric ID of the strategy_plan object to update

Bodyapplication/jsonrequired
versioninteger
campaign_plan_idinteger
channelsArray of strings
namestring<= 128 characters
feature_compatibilitystring<= 1024 characters
device_graph_onlyboolean
idinteger
campaign_idinteger
zone_namestring
Example: "America/New_York"
campaign_service_typestring
typestring
durationobject(strategy_plan_duration)
budgetobject(strategy_plan_budget)
goalsobject(strategy_plan_goals)
frequencyobject(strategy_plan_frequency)
inventoryobject(strategy_plan_inventory)
targetingobject(strategy_plan_targeting)
creativesobject(strategy_plan_creatives)
curl -i -X POST \
  'https://api.mediamath.com/api/v3.0/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": "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"
        }
      ]
    },
    "creatives": {
      "ad_expandable": true,
      "ad_formats": [
        "string"
      ],
      "ad_sizes": [
        "string"
      ]
    }
  }'

Responses

New strategy plan response

Bodyapplication/json
dataobject

New Strategy Plan

metaobject
Response
application/json
{
  "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"
  }
}

Delete a New Strategy Plan

Request

Delete a new strategy plan by ID

Security
Auth0
Path
strategy_plan_idintegerrequired

Array numeric IDs of the strategy_plan object to delete

curl -i -X DELETE \
  'https://api.mediamath.com/api/v3.0/new_strategy_plans/{strategy_plan_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Strategy plans deleted response

Bodyapplication/json
metaobject(single_metadata)
Response
application/json
{
  "meta": {
    "status": "success"
  }
}

List New Strategy Plans

Request

Get a list of new strategy plans

Security
Auth0
Query
organization_idinteger

Numeric ID of the organization to get campaign plans for

agency_idinteger

Numeric ID of the agency to get campaign plans for

advertiser_idinteger

Numeric ID of the advertiser to get campaign plans for

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/new_strategy_plans?organization_id=0&agency_id=0&advertiser_id=0&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 new strategy plans response

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

Create a New Strategy Plan

Request

Create a new strategy plan

Security
Auth0
Bodyapplication/jsonrequired
advertiser_idinteger
campaign_plan_idinteger
channelsArray of strings
namestring<= 128 characters
feature_compatibilitystring<= 1024 characters
device_graph_onlyboolean
idinteger
versioninteger
campaign_idinteger
zone_namestring
Example: "America/New_York"
campaign_service_typestring
typestring
durationobject(strategy_plan_duration)
budgetobject(strategy_plan_budget)
goalsobject(strategy_plan_goals)
frequencyobject(strategy_plan_frequency)
inventoryobject(strategy_plan_inventory)
targetingobject(strategy_plan_targeting)
creativesobject(strategy_plan_creatives)
curl -i -X POST \
  https://api.mediamath.com/api/v3.0/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": "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"
        }
      ]
    },
    "creatives": {
      "ad_expandable": true,
      "ad_formats": [
        "string"
      ],
      "ad_sizes": [
        "string"
      ]
    }
  }'

Responses

New strategy plan response

Bodyapplication/json
dataobject

New Strategy Plan

metaobject
Response
application/json
{
  "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"
  }
}

List New Strategy Plan Target Values

Request

Get a list of new strategy plan target values

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

Responses

List target values 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"
  }
}

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