Audience Segment Estimates CPM and Size

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

Servers

Mock server

https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/

Organizations

Operations

Agencies

Operations

Advertisers

Operations

Campaigns

Operations

Strategies

Operations

Targeting

Operations

Get a list of attachments

Request

Get a list of attachments

curl -i -X GET \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

Create an attachment

Request

Create an attachment

Bodyapplication/json

target_idnumber>= 1required

strategy_idnumber>= 0required

restrictionstringnon-emptyrequired

Enum"INCLUDE""EXCLUDE"

operatorstringnon-emptyrequired

Enum"OR""AND"

or_betterboolean

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "target_id": 1,
    "strategy_id": 0,
    "restriction": "INCLUDE",
    "operator": "OR",
    "or_better": true
  }'

Responses

Attachment response

Bodyapplication/json

dataobject(attachment_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 1,
    "entity_type": "string",
    "target_id": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "created_on": "string",
    "updated_on": "string",
    "version": 0,
    "or_better": true
  },
  "meta": {
    "status": "success"
  }
}

Get a list of attachments

Request

Get a list of attachments

curl -i -X GET \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachment \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

Create an attachment

Request

Create an attachment

Bodyapplication/json

target_idnumber>= 1required

strategy_idnumber>= 0required

restrictionstringnon-emptyrequired

Enum"INCLUDE""EXCLUDE"

operatorstringnon-emptyrequired

Enum"OR""AND"

or_betterboolean

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachment \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "target_id": 1,
    "strategy_id": 0,
    "restriction": "INCLUDE",
    "operator": "OR",
    "or_better": true
  }'

Responses

Attachment response

Bodyapplication/json

dataobject(attachment_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 1,
    "entity_type": "string",
    "target_id": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "created_on": "string",
    "updated_on": "string",
    "version": 0,
    "or_better": true
  },
  "meta": {
    "status": "success"
  }
}

Get a specific attachment

Request

Get an attachment by ID

Path

attachment_idintegerrequired

Numeric ID of the attachment to get

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachments/{attachment_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Attachment response

Bodyapplication/json

dataobject(attachment_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 1,
    "entity_type": "string",
    "target_id": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "created_on": "string",
    "updated_on": "string",
    "version": 0,
    "or_better": true
  },
  "meta": {
    "status": "success"
  }
}

Update an attachment

Request

Update an attachment by id

Path

attachment_idintegerrequired

Numeric ID of the attachment to update

Bodyapplication/json

target_idnumber>= 0

versionnumberrequired

strategy_idnumber>= 1

restrictionstringnon-empty

Enum"INCLUDE""EXCLUDE"

operatorstringnon-empty

Enum"OR""AND"

or_betterboolean

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachments/{attachment_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "target_id": 0,
    "version": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "or_better": true
  }'

Responses

Attachment response

Bodyapplication/json

dataobject(attachment_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 1,
    "entity_type": "string",
    "target_id": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "created_on": "string",
    "updated_on": "string",
    "version": 0,
    "or_better": true
  },
  "meta": {
    "status": "success"
  }
}

Delete an attachment

Request

Delete an attachment by id

Path

attachment_idintegerrequired

Numeric ID of the attachment to delete

curl -i -X DELETE \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachments/{attachment_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Empty response

Bodyapplication/json

object

Response

application/json

{}

Get a specific attachment

Request

Get an attachment by ID

Path

attachment_idintegerrequired

Numeric ID of the attachment to get

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachment/{attachment_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Attachment response

Bodyapplication/json

dataobject(attachment_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 1,
    "entity_type": "string",
    "target_id": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "created_on": "string",
    "updated_on": "string",
    "version": 0,
    "or_better": true
  },
  "meta": {
    "status": "success"
  }
}

Update an attachment

Request

Update an attachment by id

Path

attachment_idintegerrequired

Numeric ID of the attachment to update

Bodyapplication/json

target_idnumber>= 0

versionnumberrequired

strategy_idnumber>= 1

restrictionstringnon-empty

Enum"INCLUDE""EXCLUDE"

operatorstringnon-empty

Enum"OR""AND"

or_betterboolean

curl -i -X PUT \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachment/{attachment_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "target_id": 0,
    "version": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "or_better": true
  }'

Responses

Attachment response

Bodyapplication/json

dataobject(attachment_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "id": 1,
    "entity_type": "string",
    "target_id": 0,
    "strategy_id": 1,
    "restriction": "INCLUDE",
    "operator": "OR",
    "created_on": "string",
    "updated_on": "string",
    "version": 0,
    "or_better": true
  },
  "meta": {
    "status": "success"
  }
}

Delete an attachment

Request

Delete an attachment by id

Path

attachment_idintegerrequired

Numeric ID of the attachment to delete

curl -i -X DELETE \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/attachment/{attachment_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Empty response

Response

No content

(Legacy) List targets

Request

Get a list of targets

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

sort_orderstring

Sorting order for the sort_by parameter for the result list

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.

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/target?page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name&sort_order=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

(Legacy) Create a target

Request

Create a target

Bodyapplication/json

parent_idnumber

namestringnon-emptyrequired

factual_idstring

mediamath_organization_idnumber

target_inetstringnon-empty

visibleboolean

visible_overriddenboolean

bidder_frequencynumber

dimension_codestringnon-empty

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/target \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  }'

Responses

Target response

Bodyapplication/json

dataobject(target_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  },
  "meta": {
    "status": "success"
  }
}

(Legacy) Get a specific target

Request

Get a target by id

Path

target_idintegerrequired

Numeric ID of the target to get

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/target/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Target response

Bodyapplication/json

dataobject(target_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  },
  "meta": {
    "status": "success"
  }
}

(Legacy) Update a target

Request

Update a target by id

Path

target_idintegerrequired

Numeric ID of the target to update

Bodyapplication/json

parent_idnumber

namestringnon-empty

factual_idstring

mediamath_organization_idnumber

target_inetstringnon-empty

visibleboolean

visible_overriddenboolean

bidder_frequencynumber

dimension_codestringnon-empty

versioninteger

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/target/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string",
    "version": 0
  }'

Responses

Target response

Bodyapplication/json

dataobject(target_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  },
  "meta": {
    "status": "success"
  }
}

(Legacy) Delete a specific target

Request

Delete a target by id

Path

target_idintegerrequired

Numeric ID of the target to delete

curl -i -X DELETE \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/target/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

(Legacy) Update a target

Request

Update a target by id

Path

target_idintegerrequired

Numeric ID of the target to update

Bodyapplication/json

parent_idnumber

namestringnon-empty

factual_idstring

mediamath_organization_idnumber

target_inetstringnon-empty

visibleboolean

visible_overriddenboolean

bidder_frequencynumber

dimension_codestringnon-empty

versioninteger

curl -i -X PUT \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/target/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string",
    "version": 0
  }'

Responses

Target response

Bodyapplication/json

dataobject(target_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  },
  "meta": {
    "status": "success"
  }
}

List targets

Request

Get a list of targets

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

Example: sort_by=id, -id, name, -name

sort_orderstring

Sorting order for the sort_by parameter for the result list

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.

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/targets?page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name&sort_order=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

Create a target

Request

Create a target

Bodyapplication/json

parent_idnumber

namestringnon-emptyrequired

factual_idstring

mediamath_organization_idnumber

target_inetstringnon-empty

visibleboolean

visible_overriddenboolean

bidder_frequencynumber

dimension_codestringnon-empty

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/targets \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  }'

Responses

Target response

Bodyapplication/json

dataobject(target_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  },
  "meta": {
    "status": "success"
  }
}

Get a specific target

Request

Get a target by id

Path

target_idintegerrequired

Numeric ID of the target to get

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/targets/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Target response

Bodyapplication/json

dataobject(target_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  },
  "meta": {
    "status": "success"
  }
}

Update a target

Request

Update a target by id

Path

target_idintegerrequired

Numeric ID of the target to update

Bodyapplication/json

parent_idnumber

namestringnon-empty

factual_idstring

mediamath_organization_idnumber

target_inetstringnon-empty

visibleboolean

visible_overriddenboolean

bidder_frequencynumber

dimension_codestringnon-empty

versioninteger

curl -i -X POST \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/targets/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string",
    "version": 0
  }'

Responses

Target response

Bodyapplication/json

dataobject(target_base)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "parent_id": 0,
    "name": "string",
    "factual_id": "string",
    "mediamath_organization_id": 0,
    "target_inet": "string",
    "visible": true,
    "visible_overridden": true,
    "bidder_frequency": 0,
    "dimension_code": "string"
  },
  "meta": {
    "status": "success"
  }
}

Delete a specific target

Request

Delete a target by id

Path

target_idintegerrequired

Numeric ID of the target to delete

curl -i -X DELETE \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/targets/{target_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

List target paths

Request

Get a list of target paths

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

Example: sort_by=id, -id, name, -name

sort_orderstring

Sorting order for the sort_by parameter for the result list

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.

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/target-path?page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name&sort_order=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

Audience Segment Estimates CPM and Size

Request

Audience Segment Estimates CPM and Size

Bodyapplication/json

currency_codestring= 3 charactersrequired

Example: "USD"

includeArray of objectsrequired

include[].operatorstring

include[].segmentsArray of objects

excludeobject

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/audience_segments/estimate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency_code": "USD",
    "include": [
      {
        "operator": "string",
        "segments": [
          {
            "audience_segment_id": 0,
            "user_cpm": 0
          }
        ]
      }
    ],
    "exclude": {
      "operator": "string",
      "segments": [
        {
          "audience_segment_id": 0,
          "user_cpm": 0
        }
      ]
    }
  }'

Responses

estimate response

Bodyapplication/json

dataobject

metaobject

Response

application/json

{
  "data": {
    "cpm": { … },
    "size": 0
  },
  "meta": {
    "status": "success"
  }
}

Add and view Targeting

Request

add and view targeting

Bodyapplication/json

strategy_idArray of integersrequired

targetingobject(targeting_base)

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/targeting \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "strategy_id": [
      0
    ],
    "targeting": {
      "audience": {
        "include": [
          {
            "operator": "AND",
            "audience_segment_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "operator": "AND",
            "audience_segment_ids": [
              0
            ]
          }
        ]
      },
      "contextual": {
        "include": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ]
      },
      "my_data": {
        "include": {
          "pixel_bundle_ids": [
            0
          ],
          "operator": "AND"
        },
        "exclude": {
          "pixel_bundle_ids": [
            0
          ]
        }
      },
      "location": {
        "include": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ]
      },
      "technology": {
        "include": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ],
        "exclude": [
          {
            "code": "string",
            "operator": "AND",
            "target_value_ids": [
              0
            ]
          }
        ]
      },
      "day_parts": [
        {
          "user_time": true,
          "start_hour": 1,
          "end_hour": 5,
          "days": [
            "M",
            "T",
            "W",
            "S",
            "U"
          ]
        }
      ]
    }
  }'

Responses

Bodyapplication/json

dataobject

metaobjectrequired

meta.statusstringnon-emptyrequired

meta.countnumberrequired

errorsArray of any or null

Response

application/json

{
  "data": {
    "location": [ … ]
  },
  "meta": {
    "status": "string",
    "count": 0
  },
  "errors": [
    null
  ]
}

Contextual Segments CPM estimates

Request

Contextual Segments CPM estimates

Bodyapplication/json

currency_codestring= 3 charactersrequired

Example: "USD"

includeArray of objects

excludeobject

curl -i -X POST \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/contextual_segments/cpm_estimate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency_code": "USD",
    "include": [
      {
        "code": "string",
        "operator": "string",
        "segments": [
          {
            "targeting_segment_id": 0,
            "user_cpm": 0
          }
        ]
      }
    ],
    "exclude": {
      "code": "string",
      "operator": "string",
      "segments": [
        {
          "targeting_segment_id": 0,
          "user_cpm": 0
        }
      ]
    }
  }'

Responses

cpm estimate response

Bodyapplication/json

dataobject

metaobject

Response

application/json

{
  "data": {
    "cpm": { … }
  },
  "meta": {
    "status": "success"
  }
}

Frequently used Contextual Segments

Request

Display the most frequently used contextual segments for a given advertiser

Query

advertiser_idinteger

Numeric ID of the advertiser to filter on

topinteger

limit of top elements

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/targeting_segments/frequently_used?advertiser_id=0&top=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

targeting segment and parent vendor information for display

Bodyapplication/json

dataArray of objects or null

metaobject

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success"
  }
}

Frequently used Audience Segments

Request

Display the most frequently used audience segments for a given advertiser or campaign.

Query

advertiser_idinteger

Numeric ID of the advertiser to filter on

campaign_idinteger

Numeric ID of the campaign to filter on

topinteger

limit of top elements

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/audience_segments/frequently_used?advertiser_id=0&campaign_id=0&top=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

targeting segment and parent vendor information for display

Bodyapplication/json

dataArray of objects or null

metaobject

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success"
  }
}

List technology target values

Request

Get list of technology target values

Query

namestring

Case insensitive name contains search

full_pathstring

Case insensitive full_path contains search

dimension_codestringrequired

Comma separated list of dimension codes

sort_bystring

field to sort by (ascending default, prepend '-' for descending)

qstring

common query searching and pattern matching for fields

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/technology_target_values?dimension_code=string&full_path=string&name=string&q=string&sort_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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

Fetch Contextual Segments

Request

Get a list of contextual-segments

curl -i -X GET \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/path_targeting_segments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

Fetch Path Audience Segments

Request

Get a list of path-audience-segments

curl -i -X GET \
  https://apidocs.mediamath.com/_mock/apis/campaigns-api/openapi/path_audience_segments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

standard list of entities

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

Vendor Contracts

Operations

Strategy Templates

Operations

Atomic Creatives

Operations

Concepts

Operations

Creatives

Operations

Pixel Bundles

Operations

Campaign Plans

Operations

Strategy Plans

Operations

Bulk Update

Operations

Marketplaces

Operations

Users

Operations

Enterprise Controls

Operations

General

Operations

Currency Rates

Operations

Site Lists

Operations

Timezones

Operations

Strategy Groups

Operations

Strategy Day Parts

Operations

Strategy Deals

Operations

Strategy IP Addresses

Operations

Strategy Concepts

Operations

Targeting Segments

Operations

Strategy Target Values

Operations

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

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

Campaigns API (xx.xx.xx)

Organizations

Agencies

Advertisers

Campaigns

Strategies

Targeting

Get a list of attachments

Request

Responses

Was this helpful?

Create an attachment

Request

Responses

Was this helpful?

Get a list of attachments

Request

Responses

Was this helpful?

Create an attachment

Request

Responses

Was this helpful?

Get a specific attachment

Request

Responses

Was this helpful?

Update an attachment

Request

Responses

Was this helpful?

Delete an attachment

Request

Responses

Was this helpful?

Get a specific attachment

Request

Responses

Was this helpful?

Update an attachment

Request

Responses

Was this helpful?

Delete an attachment

Request

Responses

Was this helpful?

(Legacy) List targets

Request

Responses

Was this helpful?

(Legacy) Create a target

Request

Responses

Was this helpful?

(Legacy) Get a specific target

Request

Responses

Was this helpful?

(Legacy) Update a target

Request

Responses

Was this helpful?

(Legacy) Delete a specific target

Request

Responses

Was this helpful?

(Legacy) Update a target

Request

Responses

Was this helpful?

List targets

Request

Responses

Was this helpful?

Create a target

Request

Responses

Was this helpful?

Get a specific target

Request

Request

Request