Jumpstart
/
Get serialized jumpstarts

BYOA

Custom Brain

Custom Brain allows the client to use the BYOA API to upload a set of logistic coefficients corresponding to any of the variables currently in use by the MediaMath Brain. These coefficients will then be used by participating strategies to calculate the predicted response rate for each impression. The bidder will calculate bid price by multipling the predicted response rate by the strategy's goal value. Goal values can be modified using the MediaMath Platform campaign management API.

It is best for you to contact us early in your process by emailing developers@mediamath.com, as it may take about 48 hours before you are granted API access to begin work on your model.

BYOM

Download OpenAPI description
byoa-api.json
byoa-api.yaml
Overview
URL http://devblog.mediamath.com
BYOA API Support byoa@mediamath.com
License Apache 2.0
Languages
Servers
Mock server
https://apidocs.mediamath.com/_mock/apis/byoa-api/
https://api.byoa.mediamath.com/

Aggregate

Internal methods to create model from a group of campaigns

Operations

Bid Valuator

Internal - Bid valuator

Campaign Settings

BYOA (Bring Your Own Algorithm) allows advertisers to apply their own bidding algorithms within MediaMath. The participating campaigns and strategies are configured with the BYOA Campaign Settings

Operations

Custom Bid Router

Custom Bid Router further extends the BYOA architecture allowing advertisers to apply their own bidding algorithms in their own ecosystem. The MediaMath system will invoke an external call to the client with the bid request and await a response that MediaMath can use in our internal auction. Forwarded bid requests adhere to OpenRTB v2.4 format and may be enriched with certain information such as segment membership and pixel recency.

Operations

Custom Brain

In Customized Brain, the client uses the BYOA API to upload a set of logistic coefficients corresponding to any of the variables currently in use by the MediaMath Brain. These coefficients will then be used by participating strategies to calculate the predicted response rate for each impression. The bidder will calculate bid price by multiplying the predicted response rate by the strategy's goal value. Goal values can be modified using the T1 campaign management API.

Operations

Executors

Internal methods used to configure Log Brain and Tree Brain executors

Operations

Jumpstart

Internal - Jumpstart campaigns

Operations

Get Jumpstart

Request

Get jumpstart setting

Path
campaign_idstringrequired

_

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/byoa-api/jumpstarts/{campaign_id}' \
  -H 'adama_session: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "campaign_id": 111111,
    "campaign_ids": [ … ],
    "created_on": "2019-03-04T21:36:23.126385Z",
    "id": 1,
    "namespace": "123456",
    "updated_on": "2019-03-04T21:36:23.126385Z"
  },
  "meta": {
    "status": "success"
  }
}

Create or modify jumpstart

Request

Create/Modify a jumpstart for a given campaign_id, namespace and list of campaign_ids

Path
campaign_idstringrequired

_

Bodyapplication/json

_

namespacestring
campaign_idsArray of integers
curl -i -X PUT \
  'https://apidocs.mediamath.com/_mock/apis/byoa-api/jumpstarts/{campaign_id}' \
  -H 'Content-Type: application/json' \
  -H 'adama_session: YOUR_API_KEY_HERE' \
  -d '{
    "namespace": "string",
    "campaign_ids": [
      0
    ]
  }'

Responses

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "campaign_id": 111111,
    "campaign_ids": [ … ],
    "created_on": "2019-03-04T21:36:23.126385Z",
    "id": 1,
    "namespace": "123456",
    "updated_on": "2019-03-04T21:36:23.126385Z"
  },
  "meta": {
    "status": "success"
  }
}

Delete jumpstart

Request

Delete jumpstart settings

Path
campaign_idstringrequired

_

curl -i -X DELETE \
  'https://apidocs.mediamath.com/_mock/apis/byoa-api/jumpstarts/{campaign_id}' \
  -H 'adama_session: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject
metaobject
Response
application/json
{
  "data": {
    "campaign_id": 111111,
    "campaign_ids": [ … ],
    "created_on": "2019-03-04T21:36:23.126385Z",
    "id": 1,
    "namespace": "123456",
    "updated_on": "2019-03-04T21:36:23.126385Z"
  },
  "meta": {
    "status": "success"
  }
}

Get serialized jumpstarts

Request

Retrieve all jumpstarts

curl -i -X GET \
  https://apidocs.mediamath.com/_mock/apis/byoa-api/jumpstarts/serialize_all \
  -H 'adama_session: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects
metaobject
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "status": "success"
  }
}

Get serialized jumpstarts

Request

Retrieve all jumpstarts from a namespace

Query
namespacestringrequired

namespace

curl -i -X GET \
  'https://apidocs.mediamath.com/_mock/apis/byoa-api/jumpstarts/serialize?namespace=string' \
  -H 'adama_session: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataArray of objects
metaobject
Response
application/json
{
  "data": [
    { … },
    { … }
  ],
  "meta": {
    "status": "success"
  }
}

Serialize

Internal methods to update the BYOA execution engines with current campaigns and settings

Operations