Bulk Campaign Audit Log

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

https://apidocs.mediamath.com/

Organizations

Operations

Agencies

Operations

Advertisers

Operations

Campaigns

Operations

Get A Specific Campaign

Request

Get a campaign by id

Security

Auth0

Path

campaign_idintegerrequired

Numeric ID of the campaign to get

Query

extendedboolean

Get extended properties in response

curl -i -X GET \
  'https://apidocs.mediamath.com/campaigns/{campaign_id}?extended=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

Any of:

archivedboolean

Default false

statusboolean

Default true

namestring[ 1 .. 256 ] characters

service_typestring

Enum"SELF""MANAGED"

io_namestring<= 256 characters

io_reference_numstring<= 32 characters

is_programmatic_guaranteedboolean

politicalboolean

Default false

source_campaign_idinteger or null

zone_namestringnon-empty

idinteger

versioninteger

advertiser_idintegerread-only

created_onstring(date-time)read-only

updated_onstring(date-time)read-only

identityobject(campaign_identity)

ad_serverobject(campaign_ad_server)

durationobject

Duration of campaigns must not exceed 36 months

goalsobject(campaign_goals)

budgetobject

frequency_capobject(campaign_frequency)

pacingobject(campaign_pacing)

inventoryobject

attributionobject(campaign_attribution)

budget_flightsArray of objects(budget_flight_full)

viewabilityobject or null(campaign_viewability)

vendor_contractsArray of objects(vendor_contract)

site_listsArray of objects(campaign_site_list)

custom_brain_selectionsArray of objects(campaign_custom_brain_selection)

strategiesobject

strategy_groupsobject

mfa_avoidancestring

Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"

Response

application/json

{
  "archived": false,
  "status": true,
  "name": "string",
  "service_type": "SELF",
  "io_name": "string",
  "io_reference_num": "string",
  "is_programmatic_guaranteed": true,
  "political": false,
  "source_campaign_id": 0,
  "zone_name": "string",
  "id": 0,
  "version": 0,
  "advertiser_id": 0,
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "identity": {
    "device_graph_only": false,
    "bid_min_devices": 1,
    "connected_id_type": "DETERMINISTIC_FIRST"
  },
  "ad_server": {
    "ad_server_id": 0,
    "ad_server_username": "string",
    "ad_server_password": "string",
    "use_default_ad_server": true,
    "ad_server_fee": 9999999.99
  },
  "duration": {
    "start_date": "2019-08-24T14:15:22Z",
    "end_date": "2019-08-24T14:15:22Z",
    "initial_start_date": "2019-08-24T14:15:22Z"
  },
  "goals": {
    "goal_type": "spend",
    "goal_alert": 9999999.99,
    "goal_value": 0.0001,
    "goal_category": "audience"
  },
  "budget": {
    "total_budget": 0.1,
    "total_impression_budget": 0,
    "currency_code": "USD",
    "margin_pct": 9999999.9999,
    "dynamic_budget_allocation_type": "SBA_AUTO_ALLOCATION",
    "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
    "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z",
    "flights": [ … ]
  },
  "frequency_cap": {
    "frequency_type": "even",
    "frequency_interval": "hour",
    "frequency_amount": 0,
    "use_mm_freq": false,
    "frequency_optimization": false
  },
  "pacing": {
    "pacing_alert": 0,
    "impression_cap_automatic": false,
    "impression_cap_amount": 0,
    "impression_cap_type": "even",
    "spend_cap_type": "even",
    "spend_cap_amount": 0,
    "spend_cap_automatic": true,
    "brain_intraday_pacing": false
  },
  "inventory": {
    "ads_txt_verified": "ANY",
    "minimize_multi_ads": false,
    "override_suspicious_traffic_filter": false,
    "suspicious_traffic_filter_level": 25,
    "dcs_data_is_campaign_level": false,
    "restrict_targeting_to_deterministic_id": false,
    "restrict_targeting_to_same_device_id": true,
    "effective_ads_txt_verified": "ANY"
  },
  "attribution": {
    "has_custom_attribution": false,
    "custom_attribution_source": "3rd Party Attribution",
    "pc_window_minutes": 0,
    "pv_window_minutes": 0,
    "pv_pct": 100,
    "merit_pixel_id": 0,
    "conversion_type": "every",
    "conversion_variable_minutes": 1
  },
  "budget_flights": [
    { … }
  ],
  "viewability": {
    "vendor_id": 0,
    "type": "AUTO_TAG",
    "sample_rate": 1
  },
  "vendor_contracts": [
    { … }
  ],
  "site_lists": [
    { … }
  ],
  "custom_brain_selections": [
    { … }
  ],
  "strategies": {
    "count": 0,
    "strategies_list": [ … ],
    "distinct_strategy_goal_types": [ … ]
  },
  "strategy_groups": {
    "count": 0,
    "strategy_groups_list": [ … ]
  },
  "mfa_avoidance": "INHERIT"
}

Update A Campaign

Request

Update a campaign by id

Security

Auth0

Path

campaign_idintegerrequired

Numeric ID of the campaign to update

Bodyapplication/json

archivedboolean

Default false

statusboolean

Default true

namestring[ 1 .. 256 ] characters

service_typestring

Enum"SELF""MANAGED"

io_namestring<= 256 characters

io_reference_numstring<= 32 characters

is_programmatic_guaranteedboolean

politicalboolean

Default false

source_campaign_idinteger or null

zone_namestringnon-empty

advertiser_idinteger>= 1

identityobject(campaign_identity)

ad_serverobject(campaign_ad_server)

goalsobject(campaign_goals)

budgetobject

frequencyobject(campaign_frequency)

pacingobject(campaign_pacing)

inventoryobject(campaign_inventory)

attributionobject(campaign_attribution)

viewabilityobject or null(campaign_viewability)

vendor_contractsArray of objects(vendor_contract)

site_listsArray of objects

custom_brain_selectionsArray of objects

mfa_avoidancestring

Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"

curl -i -X POST \
  'https://apidocs.mediamath.com/campaigns/{campaign_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 0,
    "zone_name": "string",
    "advertiser_id": 1,
    "identity": {
      "device_graph_only": false,
      "bid_min_devices": 1,
      "connected_id_type": "DETERMINISTIC_FIRST"
    },
    "ad_server": {
      "ad_server_id": 0,
      "ad_server_username": "string",
      "ad_server_password": "string",
      "use_default_ad_server": true,
      "ad_server_fee": 9999999.99
    },
    "goals": {
      "goal_type": "spend",
      "goal_alert": 9999999.99,
      "goal_value": 0.0001,
      "goal_category": "audience"
    },
    "budget": {
      "total_budget": 0.1,
      "total_impression_budget": 0,
      "currency_code": "USD",
      "margin_pct": 9999999.9999,
      "dynamic_budget_allocation_type": "SBA_AUTO_ALLOCATION",
      "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
      "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z",
      "flights": [
        {
          "start_date": "2019-08-24T14:15:22Z",
          "end_date": "2019-08-24T14:15:22Z",
          "total_budget": 0.1,
          "total_impression_budget": 0
        }
      ]
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 0,
      "use_mm_freq": false,
      "frequency_optimization": false
    },
    "pacing": {
      "pacing_alert": 0,
      "impression_cap_automatic": false,
      "impression_cap_amount": 0,
      "impression_cap_type": "even",
      "spend_cap_type": "even",
      "spend_cap_amount": 0,
      "spend_cap_automatic": true,
      "brain_intraday_pacing": false
    },
    "inventory": {
      "ads_txt_verified": "ANY",
      "minimize_multi_ads": false,
      "override_suspicious_traffic_filter": false,
      "suspicious_traffic_filter_level": 25,
      "dcs_data_is_campaign_level": false,
      "restrict_targeting_to_deterministic_id": false,
      "restrict_targeting_to_same_device_id": true
    },
    "attribution": {
      "has_custom_attribution": false,
      "custom_attribution_source": "3rd Party Attribution",
      "pc_window_minutes": 0,
      "pv_window_minutes": 0,
      "pv_pct": 100,
      "merit_pixel_id": 0,
      "conversion_type": "every",
      "conversion_variable_minutes": 1
    },
    "viewability": {
      "vendor_id": 0,
      "type": "AUTO_TAG",
      "sample_rate": 1
    },
    "vendor_contracts": [
      {
        "vendor_id": 0,
        "use_mm_contract": true,
        "price": 0.1,
        "rate_card_type": "CPM",
        "site_lists": {
          "id": 0,
          "name": "string",
          "version": 0,
          "status": true,
          "organization_id": 0,
          "restriction": "string",
          "filename": "string",
          "campaign_id": 0,
          "assigned": true,
          "sites_count": 0,
          "sites_count_app": 0,
          "sites_count_domain": 0
        }
      }
    ],
    "site_lists": [
      {
        "id": 0,
        "assigned": true
      }
    ],
    "custom_brain_selections": [
      {
        "selection_id": 0,
        "selection_type": "Audience Target"
      }
    ],
    "mfa_avoidance": "INHERIT"
  }'

Responses

campaign response

Bodyapplication/json

dataobject(campaign_full)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 0,
    "zone_name": "string",
    "id": 0,
    "version": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "identity": { … },
    "ad_server": { … },
    "duration": { … },
    "goals": { … },
    "budget": { … },
    "frequency_cap": { … },
    "pacing": { … },
    "inventory": { … },
    "attribution": { … },
    "budget_flights": [ … ],
    "viewability": { … },
    "vendor_contracts": [ … ],
    "site_lists": [ … ],
    "custom_brain_selections": [ … ],
    "strategies": { … },
    "strategy_groups": { … },
    "mfa_avoidance": "INHERIT"
  },
  "meta": {
    "status": "success"
  }
}

List Campaigns

Request

Get a list of campaigns. The data fetched for each campaign depends on the values of query params. For example, if you use query parameter full; all properties are fetched.

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

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

Example: full=*

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

Responses

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

Create A Campaign

Request

Create a campaign

Security

Auth0

Bodyapplication/json

archivedboolean

Default false

statusboolean

Default true

namestring[ 1 .. 256 ] charactersrequired

service_typestringrequired

Enum"SELF""MANAGED"

io_namestring<= 256 characters

io_reference_numstring<= 32 characters

is_programmatic_guaranteedboolean

politicalboolean

Default false

source_campaign_idinteger or null

zone_namestringnon-empty

advertiser_idinteger>= 1required

identityobject(campaign_identity)

ad_serverobject(campaign_ad_server)

goalsobject(campaign_goals_create)required

goals.goal_typestringrequired

Enum"spend""reach""cpc""cpe""cpa""roi""ctr""vcr""viewability_rate""vcpm"

goals.goal_alertnumber(float)[ 0 .. 9999999.99 ]

goals.goal_valuenumber(float)[ 0.0001 .. 9999999.9999 ]

goals.goal_categorystring or null

Enum"audience""engagement""response"

budgetobjectrequired

budget.currency_codestring= 3 charactersrequired

Example: "USD"

budget.margin_pctnumber(float)[ 0 .. 9999999.9999 ]

budget.dynamic_budget_allocation_typestring

Default "OFF"

Enum"SBA_AUTO_ALLOCATION""SBA_RECOMMENDATIONS_ONLY""OFF"

budget.dynamic_budget_allocation_appliedstring(date-time)

budget.dynamic_budget_allocation_availablestring(date-time)

budget.flightsArray of objects(campaign_budget_flights_create)non-emptyrequired

budget.flights[].start_datestring(date-time)required

budget.flights[].end_datestring(date-time)required

The latest end date of flight must be no more than 36 months after the earliest start date

budget.flights[].total_budgetnumber(float)required

budget.flights[].total_impression_budgetinteger or null

budget.total_budgetnumber or null(float)Deprecated

budget.total_impression_budgetinteger or nullDeprecated

frequencyobject(campaign_frequency)

pacingobject(campaign_pacing)

inventoryobject(campaign_inventory)

attributionobject(campaign_attribution)

viewabilityobject or null(create_campaign_viewability)

vendor_contractsArray of objects(vendor_contract)

site_listsArray of objects

custom_brain_selectionsArray of objects

mfa_avoidancestring

Enum"INHERIT""ALLOW_ALL""EXCLUDE_MFA"

curl -i -X POST \
  https://apidocs.mediamath.com/campaigns \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 0,
    "zone_name": "string",
    "advertiser_id": 1,
    "identity": {
      "device_graph_only": false,
      "bid_min_devices": 1,
      "connected_id_type": "DETERMINISTIC_FIRST"
    },
    "ad_server": {
      "ad_server_id": 0,
      "ad_server_username": "string",
      "ad_server_password": "string",
      "use_default_ad_server": true,
      "ad_server_fee": 9999999.99
    },
    "goals": {
      "goal_type": "spend",
      "goal_alert": 9999999.99,
      "goal_value": 0.0001,
      "goal_category": "audience"
    },
    "budget": {
      "total_budget": 0.1,
      "total_impression_budget": 0,
      "currency_code": "USD",
      "margin_pct": 9999999.9999,
      "dynamic_budget_allocation_type": "SBA_AUTO_ALLOCATION",
      "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
      "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z",
      "flights": [
        {
          "start_date": "2019-08-24T14:15:22Z",
          "end_date": "2019-08-24T14:15:22Z",
          "total_budget": 0.1,
          "total_impression_budget": 0
        }
      ]
    },
    "frequency": {
      "frequency_type": "even",
      "frequency_interval": "hour",
      "frequency_amount": 0,
      "use_mm_freq": false,
      "frequency_optimization": false
    },
    "pacing": {
      "pacing_alert": 0,
      "impression_cap_automatic": false,
      "impression_cap_amount": 0,
      "impression_cap_type": "even",
      "spend_cap_type": "even",
      "spend_cap_amount": 0,
      "spend_cap_automatic": true,
      "brain_intraday_pacing": false
    },
    "inventory": {
      "ads_txt_verified": "ANY",
      "minimize_multi_ads": false,
      "override_suspicious_traffic_filter": false,
      "suspicious_traffic_filter_level": 25,
      "dcs_data_is_campaign_level": false,
      "restrict_targeting_to_deterministic_id": false,
      "restrict_targeting_to_same_device_id": true
    },
    "attribution": {
      "has_custom_attribution": false,
      "custom_attribution_source": "3rd Party Attribution",
      "pc_window_minutes": 0,
      "pv_window_minutes": 0,
      "pv_pct": 100,
      "merit_pixel_id": 0,
      "conversion_type": "every",
      "conversion_variable_minutes": 1
    },
    "viewability": {
      "vendor_id": 0,
      "type": "AUTO_TAG",
      "sample_rate": 1
    },
    "vendor_contracts": [
      {
        "vendor_id": 0,
        "use_mm_contract": true,
        "price": 0.1,
        "rate_card_type": "CPM",
        "site_lists": {
          "id": 0,
          "name": "string",
          "version": 0,
          "status": true,
          "organization_id": 0,
          "restriction": "string",
          "filename": "string",
          "campaign_id": 0,
          "assigned": true,
          "sites_count": 0,
          "sites_count_app": 0,
          "sites_count_domain": 0
        }
      }
    ],
    "site_lists": [
      {
        "id": 0,
        "assigned": true
      }
    ],
    "custom_brain_selections": [
      {
        "selection_id": 0,
        "selection_type": "Audience Target"
      }
    ],
    "mfa_avoidance": "INHERIT"
  }'

Responses

campaign response

Bodyapplication/json

dataobject(campaign_full)

metaobject(single_metadata)

Response

application/json

{
  "data": {
    "archived": false,
    "status": true,
    "name": "string",
    "service_type": "SELF",
    "io_name": "string",
    "io_reference_num": "string",
    "is_programmatic_guaranteed": true,
    "political": false,
    "source_campaign_id": 0,
    "zone_name": "string",
    "id": 0,
    "version": 0,
    "advertiser_id": 0,
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "identity": { … },
    "ad_server": { … },
    "duration": { … },
    "goals": { … },
    "budget": { … },
    "frequency_cap": { … },
    "pacing": { … },
    "inventory": { … },
    "attribution": { … },
    "budget_flights": [ … ],
    "viewability": { … },
    "vendor_contracts": [ … ],
    "site_lists": [ … ],
    "custom_brain_selections": [ … ],
    "strategies": { … },
    "strategy_groups": { … },
    "mfa_avoidance": "INHERIT"
  },
  "meta": {
    "status": "success"
  }
}

Campaign Audit Log

Request

Get a list of changes made to this campaign

Security

Auth0

Path

campaign_idintegerrequired

Numeric ID of the campaign

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://apidocs.mediamath.com/campaigns/{campaign_id}/history?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

list of changes to an entity

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

Get List Of Budget Flights

Request

Get a list of Budget Flights

Security

Auth0

Path

campaign_idintegerrequired

Numeric ID of the campaign

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

fullstring

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

Example: full=*

curl -i -X GET \
  'https://apidocs.mediamath.com/campaigns/{campaign_id}/budget_flights?full=*&page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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 Specific Campaign Dynamic Budget Allocation

Request

Legacy Endpoint - To be removed

Security

Auth0

Path

campaign_idintegerrequired

Numeric ID of the campaign

Query

fullstring

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

Example: full=*

Bodyapplication/json

dynamic_budget_allocation_appliedstring or null(date-time)

dynamic_budget_allocation_availablestring or null(date-time)

curl -i -X POST \
  'https://apidocs.mediamath.com/campaigns/{campaign_id}/dynamic_budget_allocation?full=*' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
    "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json

Any of:

dataobject

metaobject(pagination metadata)

Response

application/json

{
  "data": {
    "id": 0,
    "entity_type": "string",
    "name": "string"
  },
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Update Campaign Dynamic Budget Allocation

Request

This end point is restricted to a specific service account

Security

Auth0

Bodyapplication/jsonArray [

idintegerrequired

campaign id

dynamic_budget_allocation_appliedstring or null(date-time)

dynamic_budget_allocation_availablestring or null(date-time)

]

curl -i -X POST \
  https://apidocs.mediamath.com/campaign_dba \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": 0,
      "dynamic_budget_allocation_applied": "2019-08-24T14:15:22Z",
      "dynamic_budget_allocation_available": "2019-08-24T14:15:22Z"
    }
  ]'

Responses

dba bulk response

Bodyapplication/json

dataArray of objects(dba)

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 Details

Request

List User Permissions Details

Security

Auth0

Path

campaign_idintegerrequired

Numeric ID of the campaign

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

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://apidocs.mediamath.com/campaigns/{campaign_id}/permissions?page_limit=100&page_offset=0&q=string&sort_by=id%2C%20-id%2C%20name%2C%20-name' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

dataArray of objects(permission_campaign)

metaobject(pagination metadata)

Response

application/json

{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success",
    "count": 10,
    "total_count": 100,
    "offset": 0,
    "next_page": "string",
    "prev_page": "string"
  }
}

Bulk Campaign Audit Log

Request

Get a list of changes to these campaigns

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://apidocs.mediamath.com/audit_log/campaigns?page_limit=100&page_offset=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": [
      0
    ]
  }'

Responses

list of changes to a group 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"
  }
}

Strategies

Operations

Targeting

Operations

Vendor Contracts

Operations

Strategy Templates

Operations

Atomic Creatives

Operations

Concepts

Operations

Creatives

Operations

Pixel Bundles

Operations

Campaign Plans

Operations

Strategy Plans

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

Contracts

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

Bulk Concepts

Operations

Verticals

Operations

Audience Vendors

Operations

Supply Sources

Operations

Vendors

Operations

Ad Servers

Operations

Site Lists Site Download

Operations

Site Lists Assignments

Operations

Targeting Segment Objectives

Operations

Targeting Segment Objective

Operations

Contract

Operations

Segment Groups

Operations

Pixel Providers

Operations

Campaigns API (xx.xx.xx)

Organizations

Agencies

Advertisers

Campaigns

Get A Specific Campaign

Request

Responses

Was this helpful?

Update A Campaign

RequestExpand all

Responses

Was this helpful?

List Campaigns

Request

Responses

Was this helpful?

Create A Campaign

RequestExpand all

Responses

Was this helpful?

Campaign Audit Log

Request

Responses

Was this helpful?

Get List Of Budget Flights

Request

Responses

Was this helpful?

Update Specific Campaign Dynamic Budget Allocation

Request

Responses

Was this helpful?

Update Campaign Dynamic Budget Allocation

Request

Responses

Was this helpful?

List User Permissions Details

Request

Responses

Was this helpful?

Bulk Campaign Audit Log

Request

Responses

Was this helpful?

Strategies

Targeting

Vendor Contracts

Strategy Templates

Atomic Creatives

Concepts

Creatives

Pixel Bundles

Campaign Plans

Strategy Plans

Bulk Update

Marketplaces

Users

Enterprise Controls

General

Currency Rates

Site Lists

Timezones

Strategy Groups

Strategy Day Parts

Strategy Deals

Strategy IP Addresses

Strategy Concepts

Targeting Segments

Strategy Target Values

Contracts

List Organization Settings

Update Organization Settings

New Strategy Plans

Strategy Plan Target Values

Campaigns Budget Flights

User Settings

Update User Settings

Bulk Concepts

Verticals

Request

Request