{"items":[{"type":"link","label":"BYOA","link":"/apis/byoa-api","routeSlug":"/apis/byoa-api","content":{"contentType":"overview","meta":{"name":"BYOA"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"byoa-api.json","url":"/_bundle/apis/byoa-api.json?download"},{"kind":"download","label":"byoa-api.yaml","url":"/_bundle/apis/byoa-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"http://devblog.mediamath.com","url":"http://devblog.mediamath.com"},{"kind":"email","title":"BYOA API Support","email":"byoa@mediamath.com","label":"byoa@mediamath.com","withCopyButton":true,"copyContent":"byoa@mediamath.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.byoa.mediamath.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"BYOA","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/apis/byoa-api"}],"sectionId":"/apis/byoa-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/custom-brain"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Brain"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"BYOM","src":"https://mediamath.github.io/api-docs/images/BYOA-CustomBrain.png","title":"BYOM Architecture"},"children":[]}]}]}]}],"sectionId":"/apis/byoa-api/section/custom-brain"}]}]}},{"type":"link","label":"Custom Brain","link":"/apis/byoa-api/section/custom-brain","routeSlug":"/apis/byoa-api/section/custom-brain","content":null},{"type":"group","label":"Campaign Settings","link":"/apis/byoa-api/campaign-settings","routeSlug":"/apis/byoa-api/campaign-settings","items":[{"label":"Strategy based Campaign Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/campaign-settings/get_campaign_settings-campaign_id-strategies-strategy_id","routeSlug":"/apis/byoa-api/campaign-settings/get_campaign_settings-campaign_id-strategies-strategy_id","metadata":{"seo":{"title":"Strategy based Campaign Details","description":"Get strategy level Campaign Setting"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_campaign_settings-campaign_id-strategies-strategy_id","name":"Strategy based Campaign Details","isWebhook":false,"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Strategy based Campaign Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get strategy level Campaign Setting"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"strategy_id","in":"path","schemaId":"schema_345","description":"_","required":true},{"name":"campaign_id","in":"path","schemaId":"schema_345","description":"_","required":true}],"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"strategy_id","in":"path","required":true,"schemaId":"schema_345"},{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","href":"campaign-settings/get_campaign_settings-campaign_id-strategies-strategy_id","openApiOperationId":"GET_campaign_settings-campaign_id-strategies-strategy_id","summary":"Strategy based Campaign Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-settings/get_campaign_settings-campaign_id-strategies-strategy_id"}],"panels":[]}]},"httpPath":"/campaign_settings/{campaign_id}/strategies/{strategy_id}"},{"label":"Strategy based Campaign Delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/campaign-settings/delete_campaign_settings-campaign_id-strategies-strategy_id","routeSlug":"/apis/byoa-api/campaign-settings/delete_campaign_settings-campaign_id-strategies-strategy_id","metadata":{"seo":{"title":"Strategy based Campaign Delete","description":"Delete Campaign Setting with Campaign, Strategy"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_campaign_settings-campaign_id-strategies-strategy_id","name":"Strategy based Campaign Delete","isWebhook":false,"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Strategy based Campaign Delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Campaign Setting with Campaign, Strategy\n\nNo request body for this type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"strategy_id","in":"path","schemaId":"schema_345","description":"_","required":true},{"name":"campaign_id","in":"path","schemaId":"schema_345","description":"_","required":true}],"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"strategy_id","in":"path","required":true,"schemaId":"schema_345"},{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","href":"campaign-settings/delete_campaign_settings-campaign_id-strategies-strategy_id","openApiOperationId":"DELETE_campaign_settings-campaign_id-strategies-strategy_id","summary":"Strategy based Campaign Delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_348","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_348","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_348","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-settings/delete_campaign_settings-campaign_id-strategies-strategy_id"}],"panels":[]}]},"httpPath":"/campaign_settings/{campaign_id}/strategies/{strategy_id}"},{"label":"Strategy based Campaign Create/Modify","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/campaign-settings/put_campaign_settings-campaign_id-strategies-strategy_id","routeSlug":"/apis/byoa-api/campaign-settings/put_campaign_settings-campaign_id-strategies-strategy_id","metadata":{"seo":{"title":"Strategy based Campaign Create/Modify","description":"Configure BYOA functionality at a Strategy Level for a Campaign"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_campaign_settings-campaign_id-strategies-strategy_id","name":"Strategy based Campaign Create/Modify","isWebhook":false,"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Strategy based Campaign Create/Modify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Configure BYOA functionality at a Strategy Level for a Campaign"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"strategy_id","in":"path","schemaId":"schema_345","description":"_","required":true},{"name":"campaign_id","in":"path","schemaId":"schema_345","description":"_","required":true}],"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Adama_session","in":"header","schemaId":"schema_349","description":"_","required":true},{"name":"Adama_session_exp","in":"header","schemaId":"schema_349","description":"_","required":true}],"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350","pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"uuid_type should be at the top layer and the rest should be in an array one layer deeper."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"strategy_id","in":"path","required":true,"schemaId":"schema_345"},{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[{"name":"Adama_session","in":"header","required":true,"schemaId":"schema_349"},{"name":"Adama_session_exp","in":"header","required":true,"schemaId":"schema_349"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_350"}},"responseCodes":["200","400"],"pointer":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","href":"campaign-settings/put_campaign_settings-campaign_id-strategies-strategy_id","openApiOperationId":"PUT_campaign_settings-campaign_id-strategies-strategy_id","summary":"Strategy based Campaign Create/Modify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example using cURL:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X PUT \"https://api.byoa.mediamath.com/campaign_settings/999999/strategies/888888\" \\\n  -d '{\n    \"settings\": [\n      {\n        \"executor_id\": 2,\n        \"high\": 99,\n        \"low\": 0,\n        \"model_id\": \"<ModelName>\",\n        \"namespace\": \"<OrganizationID>\"\n      }\n    ],\n    \"uuid_type\": \"UUID\"\n  }' \\\n  -H 'adama_session: <adama_session>'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X PUT \"https://api.byoa.mediamath.com/campaign_settings/999999/strategies/888888\" \\\n  -d '{\n    \"settings\": [\n      {\n        \"executor_id\": 2,\n        \"high\": 99,\n        \"low\": 0,\n        \"model_id\": \"<ModelName>\",\n        \"namespace\": \"<OrganizationID>\"\n      }\n    ],\n    \"uuid_type\": \"UUID\"\n  }' \\\n  -H 'adama_session: <adama_session>'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that executor_id must be set to 2. This refers to the current version of the MediaMath BYOA Model executor."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-settings/put_campaign_settings-campaign_id-strategies-strategy_id"}],"panels":[]}]},"httpPath":"/campaign_settings/{campaign_id}/strategies/{strategy_id}"},{"label":"Campaign Delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/campaign-settings/delete_campaign_settings-campaign_id","routeSlug":"/apis/byoa-api/campaign-settings/delete_campaign_settings-campaign_id","metadata":{"seo":{"title":"Campaign Delete","description":"Delete a Campaign"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_campaign_settings-campaign_id","name":"Campaign Delete","isWebhook":false,"pointer":"/paths/~1campaign_settings~1{campaign_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign Delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a Campaign\n\nThere is no request body for this endpoint command."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_345","description":"Campaign ID","required":true}],"pointer":"/paths/~1campaign_settings~1{campaign_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/campaign_settings/{campaign_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/campaign_settings/{campaign_id}","href":"campaign-settings/delete_campaign_settings-campaign_id","openApiOperationId":"DELETE_campaign_settings-campaign_id","summary":"Campaign Delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaign_settings~1{campaign_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/delete/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-settings/delete_campaign_settings-campaign_id"}],"panels":[]}]},"httpPath":"/campaign_settings/{campaign_id}"},{"label":"Campaign Create/Modify","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/campaign-settings/put_campaign_settings-campaign_id","routeSlug":"/apis/byoa-api/campaign-settings/put_campaign_settings-campaign_id","metadata":{"seo":{"title":"Campaign Create/Modify","description":"Configure BYOA functionality at a Campaign Level"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_campaign_settings-campaign_id","name":"Campaign Create/Modify","isWebhook":false,"pointer":"/paths/~1campaign_settings~1{campaign_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign Create/Modify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Configure BYOA functionality at a Campaign Level"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_345","description":"Campaign ID","required":true}],"pointer":"/paths/~1campaign_settings~1{campaign_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350","pointer":"/paths/~1campaign_settings~1{campaign_id}/put/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"_"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/campaign_settings/{campaign_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_350"}},"responseCodes":["200","400"],"pointer":"/campaign_settings/{campaign_id}","href":"campaign-settings/put_campaign_settings-campaign_id","openApiOperationId":"PUT_campaign_settings-campaign_id","summary":"Campaign Create/Modify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example using cURL:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"$ curl -X PUT \"https://api.byoa.mediamath.com/campaign_settings/999999\" \\\n  -d '{\n    \"settings\": [\n      {\n        \"executor_id\": 2,\n        \"high\": 99,\n        \"low\": 0,\n        \"model_id\": \"<ModelName>\",\n        \"namespace\": \"<OrganizationID>\"\n      }\n    ],\n    \"uuid_type\": \"UUID\"\n  }' \\\n  -H 'adama_session: <adama_session>'\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"$ curl -X PUT \"https://api.byoa.mediamath.com/campaign_settings/999999\" \\\n  -d '{\n    \"settings\": [\n      {\n        \"executor_id\": 2,\n        \"high\": 99,\n        \"low\": 0,\n        \"model_id\": \"<ModelName>\",\n        \"namespace\": \"<OrganizationID>\"\n      }\n    ],\n    \"uuid_type\": \"UUID\"\n  }' \\\n  -H 'adama_session: <adama_session>'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that executor_id must be set to 2. This refers to the current version of the MediaMath BYOA Model executor."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_352","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaign_settings~1{campaign_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_351","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_352","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_352","exampleIds":["paths/~1campaign_settings~1{campaign_id}/put/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-settings/put_campaign_settings-campaign_id"}],"panels":[]}]},"httpPath":"/campaign_settings/{campaign_id}"},{"label":"Campaign Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/campaign-settings/get_campaign_settings-campaign_id","routeSlug":"/apis/byoa-api/campaign-settings/get_campaign_settings-campaign_id","metadata":{"seo":{"title":"Campaign Details","description":"Get details on BYOA settings for a campaign"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_campaign_settings-campaign_id","name":"Campaign Details","isWebhook":false,"pointer":"/paths/~1campaign_settings~1{campaign_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get details on BYOA settings for a campaign"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters like page_limit and with and sort_by do not work"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaign_id","in":"path","schemaId":"schema_345","description":"Campaign ID","required":true}],"pointer":"/paths/~1campaign_settings~1{campaign_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/campaign_settings/{campaign_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"campaign_id","in":"path","required":true,"schemaId":"schema_345"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/campaign_settings/{campaign_id}","href":"campaign-settings/get_campaign_settings-campaign_id","openApiOperationId":"GET_campaign_settings-campaign_id","summary":"Campaign Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_353","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1campaign_settings~1{campaign_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_353","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1campaign_settings~1{campaign_id}/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaign-settings/get_campaign_settings-campaign_id"}],"panels":[]}]},"httpPath":"/campaign_settings/{campaign_id}"}],"content":{"contentType":"group","meta":{"name":"Campaign Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaign Settings","showPageActions":true},{"nodeType":"markdoc","content":"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"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","summary":"Strategy based Campaign Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-settings/get_campaign_settings-campaign_id-strategies-strategy_id","deprecated":false},{"title":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","summary":"Strategy based Campaign Delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/campaign-settings/delete_campaign_settings-campaign_id-strategies-strategy_id","deprecated":false},{"title":"/campaign_settings/{campaign_id}/strategies/{strategy_id}","summary":"Strategy based Campaign Create/Modify","prefix":{"name":"put","color":"put"},"badges":[],"link":"/campaign-settings/put_campaign_settings-campaign_id-strategies-strategy_id","deprecated":false},{"title":"/campaign_settings/{campaign_id}","summary":"Campaign Delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/campaign-settings/delete_campaign_settings-campaign_id","deprecated":false},{"title":"/campaign_settings/{campaign_id}","summary":"Campaign Create/Modify","prefix":{"name":"put","color":"put"},"badges":[],"link":"/campaign-settings/put_campaign_settings-campaign_id","deprecated":false},{"title":"/campaign_settings/{campaign_id}","summary":"Campaign Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaign-settings/get_campaign_settings-campaign_id","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Bid Router","link":"/apis/byoa-api/custom-bid-router","routeSlug":"/apis/byoa-api/custom-bid-router","items":[{"label":"Configuration Summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-bid-router/summary-bidvaluator-organization","routeSlug":"/apis/byoa-api/custom-bid-router/summary-bidvaluator-organization","metadata":{"seo":{"title":"Configuration Summary","description":"Get a summary of the service consisting of the defined executors, environments, and endpoints. This summary will help you identify that you have correctly configured all your endpoints for all the regions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"summary-bidvaluator-organization","name":"Configuration Summary","isWebhook":false,"pointer":"/paths/~1custombidrouter~1{org_id}~1configuration/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configuration Summary","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a summary of the service consisting of the defined executors, environments, and endpoints. This summary will help you identify that you have correctly configured all your endpoints for all the regions"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"org_id","in":"path","schemaId":"schema_354","description":"Your organization ID","required":true}],"pointer":"/paths/~1custombidrouter~1{org_id}~1configuration/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"","in":"header","schemaId":"schema_349","description":"_"}],"pointer":"/paths/~1custombidrouter~1{org_id}~1configuration/get/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"schemaId":"schema_350","pointer":"/paths/~1custombidrouter~1{org_id}~1configuration/get/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"_"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custombidrouter/{org_id}/configuration","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"org_id","in":"path","required":true,"schemaId":"schema_354"}],"query":[],"querystring":[],"header":[{"name":"","in":"header","schemaId":"schema_349"}],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_350"}},"responseCodes":["200","401"],"pointer":"/custombidrouter/{org_id}/configuration","href":"custom-bid-router/summary-bidvaluator-organization","openApiOperationId":"summary-bidvaluator-organization","summary":"Configuration Summary"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"schemaId":"schema_350","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_350"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAR_NAME (under executors) can be any executor name"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_355","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/200/content/application~1json/examples/response"]},{"code":"401","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/401/content/application~1json/examples/response"]}},"schemaId":"schema_356","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/401/content/application~1json/examples/response"]}],"pointer":"/paths/~1custombidrouter~1{org_id}~1configuration/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_355","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_355","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/200/content/application~1json/examples/response"]}}},{"code":"401","schemaId":"schema_356","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/401/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356","exampleIds":["paths/~1custombidrouter~1{org_id}~1configuration/get/responses/401/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-bid-router/summary-bidvaluator-organization"}],"panels":[]}]},"httpPath":"/custombidrouter/{org_id}/configuration"},{"label":"Executor Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-bid-router/get-executor-details","routeSlug":"/apis/byoa-api/custom-bid-router/get-executor-details","metadata":{"seo":{"title":"Executor Details","description":"The details of the Custom Bid Router executor and all attached Endpoints"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-executor-details","name":"Executor Details","isWebhook":false,"pointer":"/paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Executor Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The details of the Custom Bid Router executor and all attached Endpoints\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"executor_id","in":"path","schemaId":"schema_354","description":"The Executor ID identifies an Executor which provide a logical grouping for your Bid Valuation endpoints which are then applied to specific campaigns","required":true},{"name":"org_id","in":"path","schemaId":"schema_354","description":"Your organization ID","required":true},{"name":"executor_id","in":"path","schemaId":"schema_354","description":"The Executor ID identifies an Executor which provide a logical grouping for your Bid Valuation endpoints which are then applied to specific campaigns","required":true},{"name":"org_id","in":"path","schemaId":"schema_354","description":"Your organization ID","required":true}],"pointer":"/paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/custombidrouter/{org_id}/executors/{executor_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"executor_id","in":"path","required":true,"schemaId":"schema_354"},{"name":"org_id","in":"path","required":true,"schemaId":"schema_354"},{"name":"executor_id","in":"path","required":true,"schemaId":"schema_354"},{"name":"org_id","in":"path","required":true,"schemaId":"schema_354"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200"],"pointer":"/custombidrouter/{org_id}/executors/{executor_id}","href":"custom-bid-router/get-executor-details","openApiOperationId":"GET-executor-details","summary":"Executor Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAR_NAME is variable, the name of an executor"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/responses/200/content/application~1json/examples/response"]}],"pointer":"/paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-bid-router/get-executor-details"}],"panels":[]}]},"httpPath":"/custombidrouter/{org_id}/executors/{executor_id}"},{"label":"Executor Update","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-bid-router/patch-executor-details","routeSlug":"/apis/byoa-api/custom-bid-router/patch-executor-details","metadata":{"seo":{"title":"Executor Update","description":"The sample rate defines the percentage of the bid opportunities that are forwarded to your endpoints. The sample rate can be adjusted by the client collectively for all endpoints of an executor. This feature is useful to manage and budget system utilization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH-executor-details","name":"Executor Update","isWebhook":false,"pointer":"/paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Executor Update","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The sample rate defines the percentage of the bid opportunities that are forwarded to your endpoints. The sample rate can be adjusted by the client collectively for all endpoints of an executor. This feature is useful to manage and budget system utilization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"executor_id","in":"path","schemaId":"schema_354","description":"The Executor ID identifies an Executor which provide a logical grouping for your Bid Valuation endpoints which are then applied to specific campaigns","required":true},{"name":"org_id","in":"path","schemaId":"schema_354","description":"Your organization ID","required":true},{"name":"executor_id","in":"path","schemaId":"schema_354","description":"_","required":true},{"name":"org_id","in":"path","schemaId":"schema_354","description":"_","required":true}],"pointer":"/paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358","pointer":"/paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"_"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/custombidrouter/{org_id}/executors/{executor_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"executor_id","in":"path","required":true,"schemaId":"schema_354"},{"name":"org_id","in":"path","required":true,"schemaId":"schema_354"},{"name":"executor_id","in":"path","required":true,"schemaId":"schema_354"},{"name":"org_id","in":"path","required":true,"schemaId":"schema_354"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_358"}},"responseCodes":["200"],"pointer":"/custombidrouter/{org_id}/executors/{executor_id}","href":"custom-bid-router/patch-executor-details","openApiOperationId":"PATCH-executor-details","summary":"Executor Update"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_358"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"VAR_NAME is variable, the name of an executor"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/responses/200/content/application~1json/examples/response"]}],"pointer":"/paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357","exampleIds":["paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-bid-router/patch-executor-details"}],"panels":[]}]},"httpPath":"/custombidrouter/{org_id}/executors/{executor_id}"}],"content":{"contentType":"group","meta":{"name":"Custom Bid Router"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Bid Router","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/custombidrouter/{org_id}/configuration","summary":"Configuration Summary","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-bid-router/summary-bidvaluator-organization","deprecated":false},{"title":"/custombidrouter/{org_id}/executors/{executor_id}","summary":"Executor Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-bid-router/get-executor-details","deprecated":false},{"title":"/custombidrouter/{org_id}/executors/{executor_id}","summary":"Executor Update","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-bid-router/patch-executor-details","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Brain","link":"/apis/byoa-api/custom-brain","routeSlug":"/apis/byoa-api/custom-brain","items":[{"label":"Model Data Delete","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-brain/delete_data-namespace-models-model_id","routeSlug":"/apis/byoa-api/custom-brain/delete_data-namespace-models-model_id","metadata":{"seo":{"title":"Model Data Delete","description":"Delete a model"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE_data-namespace-models-model_id","name":"Model Data Delete","isWebhook":false,"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Model Data Delete","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a model"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"model_id","in":"path","schemaId":"schema_349","description":"Model ID","required":true},{"name":"namespace","in":"path","schemaId":"schema_349","description":"namespace","required":true}],"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/data/{namespace}/models/{model_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"model_id","in":"path","required":true,"schemaId":"schema_349"},{"name":"namespace","in":"path","required":true,"schemaId":"schema_349"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/data/{namespace}/models/{model_id}","href":"custom-brain/delete_data-namespace-models-model_id","openApiOperationId":"DELETE_data-namespace-models-model_id","summary":"Model Data Delete"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-brain/delete_data-namespace-models-model_id"}],"panels":[]}]},"httpPath":"/data/{namespace}/models/{model_id}"},{"label":"Model Data Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-brain/get_data-namespace-models-model_id","routeSlug":"/apis/byoa-api/custom-brain/get_data-namespace-models-model_id","metadata":{"seo":{"title":"Model Data Details","description":"Get Model details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_data-namespace-models-model_id","name":"Model Data Details","isWebhook":false,"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Model Data Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Model details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"model_id","in":"path","schemaId":"schema_349","description":"Model ID","required":true},{"name":"namespace","in":"path","schemaId":"schema_349","description":"namespace","required":true}],"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data/{namespace}/models/{model_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"model_id","in":"path","required":true,"schemaId":"schema_349"},{"name":"namespace","in":"path","required":true,"schemaId":"schema_349"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/data/{namespace}/models/{model_id}","href":"custom-brain/get_data-namespace-models-model_id","openApiOperationId":"GET_data-namespace-models-model_id","summary":"Model Data Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Data parameter has been drastically shortened for this example.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-brain/get_data-namespace-models-model_id"}],"panels":[]}]},"httpPath":"/data/{namespace}/models/{model_id}"},{"label":"Model Data Create/Modify","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-brain/put_data-namespace-models-model_id","routeSlug":"/apis/byoa-api/custom-brain/put_data-namespace-models-model_id","metadata":{"seo":{"title":"Model Data Create/Modify","description":"Upload Model data"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_data-namespace-models-model_id","name":"Model Data Create/Modify","isWebhook":false,"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Model Data Create/Modify","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Upload Model data"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"model_id","in":"path","schemaId":"schema_349","description":"_","required":true},{"name":"namespace","in":"path","schemaId":"schema_349","description":"_","required":true}],"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361","pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/put/requestBody","description":"Note: the data field in the example below has been radically shortened for space concerns"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/data/{namespace}/models/{model_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"model_id","in":"path","required":true,"schemaId":"schema_349"},{"name":"namespace","in":"path","required":true,"schemaId":"schema_349"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_361"}},"responseCodes":["200"],"pointer":"/data/{namespace}/models/{model_id}","href":"custom-brain/put_data-namespace-models-model_id","openApiOperationId":"PUT_data-namespace-models-model_id","summary":"Model Data Create/Modify"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_361"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/put/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/put/responses/200/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1{namespace}~1models~1{model_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/put/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_359","exampleIds":["paths/~1data~1{namespace}~1models~1{model_id}/put/responses/200/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-brain/put_data-namespace-models-model_id"}],"panels":[]}]},"httpPath":"/data/{namespace}/models/{model_id}"},{"label":"Model Data Decode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-brain/get_data-decode-namespace-models-model_id","routeSlug":"/apis/byoa-api/custom-brain/get_data-decode-namespace-models-model_id","metadata":{"seo":{"title":"Model Data Decode","description":"Get Model details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_data-decode-namespace-models-model_id","name":"Model Data Decode","isWebhook":false,"pointer":"/paths/~1data~1decode~1{namespace}~1models~1{model_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Model Data Decode","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get Model details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"model_id","in":"path","schemaId":"schema_349","description":"model ID","required":true},{"name":"namespace","in":"path","schemaId":"schema_349","description":"namespace","required":true}],"pointer":"/paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data/decode/{namespace}/models/{model_id}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"model_id","in":"path","required":true,"schemaId":"schema_349"},{"name":"namespace","in":"path","required":true,"schemaId":"schema_349"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/data/decode/{namespace}/models/{model_id}","href":"custom-brain/get_data-decode-namespace-models-model_id","openApiOperationId":"GET_data-decode-namespace-models-model_id","summary":"Model Data Decode"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The Features (under Data under data) in the example below have been extremely abbreviated for easier readability.  GoalType (under Data) is case-insensitive.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_362","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_362","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-brain/get_data-decode-namespace-models-model_id"}],"panels":[]}]},"httpPath":"/data/decode/{namespace}/models/{model_id}"},{"label":"Model Data Details for Namespace","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/byoa-api/custom-brain/get_data-namespace","routeSlug":"/apis/byoa-api/custom-brain/get_data-namespace","metadata":{"seo":{"title":"Model Data Details for Namespace","description":"Get all Models and data for a specific namespace"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_data-namespace","name":"Model Data Details for Namespace","isWebhook":false,"pointer":"/paths/~1data~1{namespace}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Model Data Details for Namespace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all Models and data for a specific namespace"},{"nodeType":"security","requirements":[{"schemes":[{"name":"oauth2","scopes":[],"type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"namespace","in":"path","schemaId":"schema_345","description":"namespace","required":true}],"pointer":"/paths/~1data~1{namespace}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"model_id","in":"query","schemaId":"schema_349","description":"Model ID"}],"pointer":"/paths/~1data~1{namespace}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/data/{namespace}","servers":[{"url":"https://api.byoa.mediamath.com"}],"parameters":{"path":[{"name":"namespace","in":"path","required":true,"schemaId":"schema_345"}],"query":[{"name":"model_id","in":"query","schemaId":"schema_349"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"oauth2","type":"oauth2","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/data/{namespace}","href":"custom-brain/get_data-namespace","openApiOperationId":"GET_data-namespace","summary":"Model Data Details for Namespace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.byoa.mediamath.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameter Data had a very long value, which has been shortened for readabiltiy here.  Really the same as doing a GET /data/{namespace}/models/{model_id}."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}/get/responses/200/content/application~1json/examples/response"]}},"schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}/get/responses/200/content/application~1json/examples/response"]},{"code":"400","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}/get/responses/400/content/application~1json/examples/response"]}},"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}/get/responses/400/content/application~1json/examples/response"]}],"pointer":"/paths/~1data~1{namespace}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}/get/responses/200/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360","exampleIds":["paths/~1data~1{namespace}/get/responses/200/content/application~1json/examples/response"]}}},{"code":"400","schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}/get/responses/400/content/application~1json/examples/response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_347","exampleIds":["paths/~1data~1{namespace}/get/responses/400/content/application~1json/examples/response"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-brain/get_data-namespace"}],"panels":[]}]},"httpPath":"/data/{namespace}"}],"content":{"contentType":"group","meta":{"name":"Custom Brain"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Brain","showPageActions":true},{"nodeType":"markdoc","content":"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."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/data/{namespace}/models/{model_id}","summary":"Model Data Delete","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-brain/delete_data-namespace-models-model_id","deprecated":false},{"title":"/data/{namespace}/models/{model_id}","summary":"Model Data Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-brain/get_data-namespace-models-model_id","deprecated":false},{"title":"/data/{namespace}/models/{model_id}","summary":"Model Data Create/Modify","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-brain/put_data-namespace-models-model_id","deprecated":false},{"title":"/data/decode/{namespace}/models/{model_id}","summary":"Model Data Decode","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-brain/get_data-decode-namespace-models-model_id","deprecated":false},{"title":"/data/{namespace}","summary":"Model Data Details for Namespace","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-brain/get_data-namespace","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"schema_345":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"integer"},"created_on":{"type":"string","format":"date-time"},"executor_id":{"type":"integer"},"high":{"type":"integer"},"low":{"type":"integer"},"model_id":{"type":"string","description":"A string describing a Brain name (or Model ID)"},"namespace":{"type":"string"},"strategy_id":{"type":"integer"},"updated_on":{"type":"string","format":"date-time"},"uuid_type":{"type":"string","enum":["CID","UUID"]}}}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}}}}},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}},"meta":{"type":"object","properties":{"status":{"type":"string"}}}}},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"integer"},"created_on":{"type":"string","format":"date-time"},"executor_id":{"type":"integer"},"high":{"type":"integer"},"low":{"type":"integer"},"model_id":{"type":"string"},"namespace":{"type":"string"},"strategy_id":{"type":"integer"},"updated_on":{"type":"string","format":"date-time"},"uuid_type":{"type":"string","enum":["CID","UUID"]}}}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}}}}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"type":"string"},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"integer"},"created_on":{"type":"string","format":"date-time"},"executor_id":{"type":"integer"},"high":{"type":"integer"},"low":{"type":"integer"},"model_id":{"type":"string"},"namespace":{"type":"string"},"updated_on":{"type":"string","format":"date-time"},"uuid_type":{"type":"string","enum":["CID","UUID"]}}}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}}}}},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"}}}},"meta":{"type":"object","properties":{"reason":{"type":"string"},"status":{"type":"string"}}}}},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"campaign_id":{"type":"integer"},"created_on":{"type":"string","format":"date-time"},"executor_id":{"type":"integer"},"high":{"type":"integer","minimum":0,"maximum":99},"low":{"type":"integer","minimum":0,"maximum":99},"model_id":{"type":"string"},"namespace":{"type":"string"},"updated_on":{"type":"string","format":"date-time"},"uuid_type":{"type":"string","enum":["CID","UUID"],"format":"CID"}}}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}}}}},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"emails":{"type":"string"},"executors":{"type":"object","properties":{"VAR_NAME":{"type":"object","properties":{"endpoints":{"type":"array","items":{"type":"object","properties":{"brain_type_id":{"type":"integer","minimum":1000,"maximum":1004},"content_type":{"type":"string","enum":["json","protobuf"]},"endpoint":{"type":"string"},"endpoint_id":{"type":"string"},"environment":{"type":"string","enum":["sandbox","production"]},"logging":{"type":"object","properties":{"logging_enabled":{"type":"boolean"},"s3_bucketname":{"type":"string"},"s3_region":{"type":"string"},"s3_role_arn":{"type":"string"}}},"pop_ids":{"type":"array","description":"Each pop_ids array entry must be 3 letters long","items":{"type":"string"}},"sample_rate":{"type":"integer"},"upstream_enabled":{"type":"boolean"},"endpoint_type":{"type":"string"}}}},"executor_id":{"type":"integer"}}}}}}},"meta":{"type":"object","properties":{"status":{"type":"string"}}}}},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["error"]}}}}},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"VAR_NAME":{"type":"object","properties":{"endpoints":{"type":"array","items":{"type":"object","properties":{"brain_type_id":{"type":"integer"},"content_type":{"type":"string"},"endpoint":{"type":"string"},"endpoint_id":{"type":"string"},"environment":{"type":"string"},"logging":{"type":"object","properties":{"logging_enabled":{"type":"boolean"}}},"pop_ids":{"type":"array","items":{"type":"string"}},"sample_rate":{"type":"integer"},"upstream_enabled":{"type":"boolean"},"endpoint_type":{"type":"string"}}}},"executor_id":{"type":"integer"}}}}},"meta":{"type":"object","properties":{"status":{"type":"string"}}}}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"type":"object","properties":{"sample_rate":{"type":"integer"}}},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"created_on":{"type":"string","format":"date-time"},"data_size":{"type":"integer"},"updated_on":{"type":"string","format":"date-time"}}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}}}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"brain_type_id":{"type":"integer"},"created_on":{"type":"string","format":"date-time"},"Data":{"type":"string"},"model_id":{"type":"string"},"Namespace":{"type":"string"},"updated_on":{"type":"string","format":"date-time"}}},"meta":{"type":"object","properties":{"status":{"type":"string","enum":["success"]}}}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"string"},"brain_type_id":{"type":"integer","minimum":1000,"maximum":1004}},"required":["data","brain_type_id"]},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"object","properties":{"brain_type_id":{"type":"integer"},"created_on":{"type":"string","format":"date-time"},"Data":{"type":"array","items":{"type":"object","properties":{"Beta":{"type":"array","items":{"type":"number"}},"Boundaries":{"nullable":true},"Features":{"type":"array","items":{"type":"object","properties":{"VAR_NAME":{"type":"number","description":"VAR_NAME changes with each entry.  The number tends to either be 0 or a Float64 close to 0 that goes over 10 digits past the right of the decimal."}}}},"GoalType":{"type":"string","enum":["cpa","cpe","cpc","ctr","roi","vcr","vcpm","viewability_rate","CPA","CPE","CPC","ROI","VCR","VCPM","VIEWABILITY_RATE"],"description":"Strategy Goal Type.  The values are case-insensitive."},"Predictions":{"type":"array","items":{"type":"number"},"nullable":true}}}},"model_id":{"type":"string"},"Namespace":{"type":"string"},"updated_on":{"type":"string","format":"date-time"}}},"meta":{"type":"object","properties":{"status":{"type":"string"}}}}},"id":"schema_362"}},"exampleStore":{"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"campaign_id":675865,"created_on":"2019-08-28T02:24:36.49769Z","executor_id":2,"high":99,"low":0,"model_id":"aggregate_2","namespace":"100667","updated_on":"2019-08-28T02:24:36.49769Z","uuid_type":"CID"}],"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_CampaignSetting","message":"CampaignSetting with campaign_id(368832), strategy_id(12345) not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/get/responses/400/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/200/content/application~1json/examples/response":{"value":{"data":[{"campaign_id":10000,"created_on":"2017-07-06T13:53:10.395836Z","executor_id":2,"high":99,"low":0,"model_id":"model_name","namespace":"mm","strategy_id":1000,"updated_on":"2017-07-06T13:53:10.395836Z","uuid_type":"CID"}],"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_CampaignSetting","message":"CampaignSetting with campaign_id(1000), strategy_id(1000) not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/200/content/application~1json/examples/response":{"value":{"data":[{"campaign_id":10000,"created_on":"2017-07-06T13:53:10.395836Z","executor_id":1,"high":99,"low":0,"model_id":"model_name","namespace":"mm","strategy_id":1000,"updated_on":"2017-07-06T13:53:10.395836Z","uuid_type":"CID"}],"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/200/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_Executor","message":"Executor with ID 1 not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}~1strategies~1{strategy_id}/put/responses/400/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}/delete/responses/200/content/application~1json/examples/response":{"value":{"data":[{"campaign_id":10000,"created_on":"2017-07-07T11:20:10.92661Z","executor_id":2,"high":99,"low":0,"model_id":"model_name","namespace":"mm","updated_on":"2017-07-07T11:20:10.92661Z","uuid_type":"CID"}],"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}/delete/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_CampaignSetting","message":"CampaignSetting with campaign_id(100000), strategy_id(0) not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}/put/responses/200/content/application~1json/examples/response":{"value":{"data":[{"campaign_id":315901,"created_on":"2017-07-05T09:22:16.862852Z","executor_id":2,"high":99,"low":0,"model_id":"model_name","namespace":"101463","updated_on":"2017-07-05T09:22:16.862852Z","uuid_type":"CID"}],"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}/put/responses/200/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}/put/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"JSON_Decode_Error"}],"meta":{"reason":"Error during decoding JSON data","status":"error"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}/put/responses/400/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}/get/responses/200/content/application~1json/examples/response":{"value":{"data":[{"campaign_id":100001,"created_on":"2019-07-16T18:19:13.801517Z","executor_id":2,"high":49,"low":0,"model_id":"tree_brain","namespace":"mm","updated_on":"2019-07-16T18:19:13.801517Z","uuid_type":"UUID"},{"campaign_id":100001,"created_on":"2019-07-16T18:19:13.801517Z","executor_id":2,"high":99,"low":50,"model_id":"campaign_100001_tf","namespace":"mm","updated_on":"2019-07-16T18:19:13.801517Z","uuid_type":"UUID"}],"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1campaign_settings~1{campaign_id}/get/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_CampaignSetting","message":"CampaignSetting with campaign_id(1), strategy_id(0) not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1campaign_settings~1{campaign_id}/get/responses/400/content/application~1json/examples/response"},"paths/~1custombidrouter~1{org_id}~1configuration/get/responses/200/content/application~1json/examples/response":{"value":{"data":{"ACME Org Production Executor":{"endpoints":[{"brain_type_id":1003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-east-1.acme.co/bid/valuate","endpoint_id":"01b0acd2-d627-472f-8abe-255e4298c078","environment":"production","logging":{"logging_enabled":false},"pop_ids":["ewr"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"bid"},{"brain_type_id":1003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-west-2.acme.co/bid/valuate","endpoint_id":"6a7f517c-6b03-4db9-baf1-dff3099fb81a","environment":"production","logging":{"logging_enabled":false},"pop_ids":["pao"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"bid"},{"brain_type_id":2003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-east-2.acme.co/win/win_notice","endpoint_id":"eb5105f8-4551-462b-a122-fbb5581ef4b9","environment":"production","logging":{"logging_enabled":false},"pop_ids":["ord"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"win"}],"executor_id":4}},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1custombidrouter~1{org_id}~1configuration/get/responses/200/content/application~1json/examples/response"},"paths/~1custombidrouter~1{org_id}~1configuration/get/responses/401/content/application~1json/examples/response":{"value":{"errors":[{"code":"No Adama write permission for namespace","message":"Error in authentication"}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1custombidrouter~1{org_id}~1configuration/get/responses/401/content/application~1json/examples/response"},"paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/responses/200/content/application~1json/examples/response":{"value":{"data":{"ACME Org Production Executor":{"endpoints":[{"brain_type_id":1003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-east-1.acme.co/bid/valuate","endpoint_id":"01b0acd2-d627-472f-8abe-255e4298c078","environment":"production","logging":{"logging_enabled":false},"pop_ids":["ewr"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"bid"},{"brain_type_id":1003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-west-2.acme.co/bid/valuate","endpoint_id":"6a7f517c-6b03-4db9-baf1-dff3099fb81a","environment":"production","logging":{"logging_enabled":false},"pop_ids":["pao"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"bid"},{"brain_type_id":2003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-east-2.acme.co/win/win_notice","endpoint_id":"eb5105f8-4551-462b-a122-fbb5581ef4b9","environment":"production","logging":{"logging_enabled":false},"pop_ids":["ord"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"win"}],"executor_id":4}},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/responses/200/content/application~1json/examples/response":{"value":{"data":{"ACME Org Production Executor":{"endpoints":[{"brain_type_id":1003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-east-1.acme.co/bid/valuate","endpoint_id":"01b0acd2-d627-472f-8abe-255e4298c078","environment":"production","logging":{"logging_enabled":false},"pop_ids":["ewr"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"bid"},{"brain_type_id":1003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-west-2.acme.co/bid/valuate","endpoint_id":"6a7f517c-6b03-4db9-baf1-dff3099fb81a","environment":"production","logging":{"logging_enabled":false},"pop_ids":["pao"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"bid"},{"brain_type_id":2003,"content_type":"protobuf","endpoint":"http://bid-handler-prod-us-east-2.acme.co/win/win_notice","endpoint_id":"eb5105f8-4551-462b-a122-fbb5581ef4b9","environment":"production","logging":{"logging_enabled":false},"pop_ids":["ord"],"sample_rate":100,"upstream_enabled":true,"endpoint_type":"win"}],"executor_id":4}},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1custombidrouter~1{org_id}~1executors~1{executor_id}/patch/responses/200/content/application~1json/examples/response"},"paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/200/content/application~1json/examples/response":{"value":{"data":{"created_on":"2017-07-05T15:21:03.228289Z","data_size":30878,"updated_on":"2017-07-05T15:21:03.228289Z"},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/200/content/application~1json/examples/response"},"paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_ModelData","message":"ModelData with namespace(mm), model_id(fake_model) not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1data~1{namespace}~1models~1{model_id}/delete/responses/400/content/application~1json/examples/response"},"paths/~1data~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response":{"value":{"data":{"brain_type_id":3,"created_on":"2019-06-04T19:10:37.951112Z","Data":"DAAA...","model_id":"aggregate_2","Namespace":"100667","updated_on":"2019-08-17T16:13:35.445614Z"},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1data~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1data~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_ModelData","message":"ModelData with namespace(mm), model_id(fake_model) not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1data~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"},"paths/~1data~1{namespace}~1models~1{model_id}/put/responses/200/content/application~1json/examples/response":{"value":{"data":{"created_on":"2019-07-05T10:18:43.250498Z","data_size":2538,"updated_on":"2019-07-05T10:18:43.250498Z"},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1data~1{namespace}~1models~1{model_id}/put/responses/200/content/application~1json/examples/response"},"paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response":{"value":{"data":{"brain_type_id":3,"created_on":"2019-06-04T19:10:37.951112Z","Data":[{"Beta":[-0.6969433426856995,0.001734119956381619,0.9618840217590332],"Boundaries":null,"Features":[{"__const":0.035219017416238785,"bidder_pixel_frequency^am:1013008":0.08368363976478577,"bidder_pixel_frequency^am:1024846":-0.011259343475103378,"bidder_pixel_frequency^am:1024856":-0.03232333064079285,"video_skippability^0":0.03521893545985222,"week_part^0":0.041367363184690475,"week_part^1":-0.008225390687584877}],"GoalType":"ctr","Predictions":null},{"Beta":[-8.242341995239258,0.00010720000136643648,0.09820403158664703],"Boundaries":null,"Features":[{"__const":-0.07225784659385681,"bidder_pixel_frequency^am:1013008":0.02445729449391365,"bidder_pixel_frequency^am:1024846":0.18239469826221466,"bidder_pixel_frequency^am:1024856":-0.08111409842967987,"video_skippability^0":-0.07225784659385681,"week_part^0":0.17733316123485565,"week_part^1":-0.21395796537399292}],"GoalType":"cpa","Predictions":null}],"model_id":"aggregate_2","Namespace":"100667","updated_on":"2019-08-17T16:13:35.445614Z"},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/200/content/application~1json/examples/response"},"paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Not_Found_ModelData","message":"ModelData with namespace(mm), model_id(fake_model) not found."}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1data~1decode~1{namespace}~1models~1{model_id}/get/responses/400/content/application~1json/examples/response"},"paths/~1data~1{namespace}/get/responses/200/content/application~1json/examples/response":{"value":{"data":{"brain_type_id":3,"created_on":"2019-06-04T19:10:37.951112Z","Data":"DAAA...","model_id":"aggregate_2","Namespace":"100667","updated_on":"2019-08-17T16:13:35.445614Z"},"meta":{"status":"success"}},"key":"response","summary":"response","id":"paths/~1data~1{namespace}/get/responses/200/content/application~1json/examples/response"},"paths/~1data~1{namespace}/get/responses/400/content/application~1json/examples/response":{"value":{"errors":[{"code":"Invalid_model_id","message":"No valid model_id provided in query"}],"meta":{"status":"error"}},"key":"response","summary":"response","id":"paths/~1data~1{namespace}/get/responses/400/content/application~1json/examples/response"}},"securitySchemeStore":{"adama-session-header":{"id":"adama-session-header","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication is provided through OAuth2. You'll need to request a Client ID and Secret key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After Authentication is established make a request to https://api.mediamath.com/api/v2.0/session with the Authorization:\"Bearer ACCESS_TOKEN header, and copy the adama_session cookie header from the response. Use both the Authorization:\"Bearer ACCESS_TOKEN\" header and adama_session= cookie in all future requests"},"children":[]}]}]}],"in":"header","paramName":"adama_session"},"oauth2":{"id":"oauth2","type":"oauth2","description":"exchange an Authorization Code for a Token","flows":{"password":{"tokenUrl":"https://auth.mediamath.com/oath/token","scopes":{}}}}},"servers":[{"url":"https://api.byoa.mediamath.com"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/byoa-api.json?download"},{"url":"/_bundle/apis/byoa-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"BYOA","description":"# Custom Brain\n\nCustom 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.\n\nIt 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.\n\n![BYOM](https://mediamath.github.io/api-docs/images/BYOA-CustomBrain.png \"BYOM Architecture\")"}},"baseSlug":"/apis/byoa-api","routesMapping":{}}