Request Decisions
POST
https://engine.monetate.net/api/engine/v1/decide/{retailerShortname}
Path Parameters
- retailerShortnamestringrequiredDescription
Body Parameters
- bodyHttpRequestBodyrequiredExample
{ "deviceId": "device id", "monetateId": "monetate id", "preview": "preview token", "customerId": "customer id", "events": [ { "eventType": "Event" } ] }Description- deviceIdstringDescription
- customerIdstringDescription
- eventsEvent[]requiredDescription
- eventTypestringrequiredDescription
- monetateIdstringDescription
- previewstringDescription
- channelstringDescription
- sdkVersionstringDescription
Responses
200
- HttpResponseBodyExample
{ "meta": { "code": 200, "errors": [], "warnings": [], "monetateId": "monetate id" }, "data": { "responses": [ { "requestId": "12345", "actions": [ { "actionType": "Action" } ] } ] } }Description- dataResponseDatarequiredExample
{ "responses": [ { "requestId": "12345", "actions": [ { "actionType": "Action" } ] } ] }Description- responsesResponse[]Description
- requestIdstringrequiredDescription
- actionsAction[]requiredDescription
- actionTypestringrequiredDescription
- impressionIdstringDescription
- impressionReportingImpressionReporting[]Description
- experience_idintegerrequiredDescription
- experience_labelstringrequiredDescription
- experience_namestringrequiredDescription
- variant_labelstringrequiredDescription
- is_controlbooleanrequiredDescription
- control_allocationrequiredDescription
- experience_typestringrequiredDescription
- has_targetsbooleanrequiredDescription
- tagsstring[]requiredDescription
- metaMetaExample
{ "code": 200, "errors": [], "warnings": [], "monetateId": "monetate id" }Description- codeintegerDescription
- errorsobject[]Description
- monetateIdstringDescription
- warningsobject[]
400
- HttpResponseBodyExample
{ "meta": { "code": 200, "errors": [], "warnings": [], "monetateId": "monetate id" }, "data": { "responses": [ { "requestId": "12345", "actions": [ { "actionType": "Action" } ] } ] } }Description- dataResponseDatarequiredExample
{ "responses": [ { "requestId": "12345", "actions": [ { "actionType": "Action" } ] } ] }Description- responsesResponse[]Description
- requestIdstringrequiredDescription
- actionsAction[]requiredDescription
- actionTypestringrequiredDescription
- impressionIdstringDescription
- impressionReportingImpressionReporting[]Description
- experience_idintegerrequiredDescription
- experience_labelstringrequiredDescription
- experience_namestringrequiredDescription
- variant_labelstringrequiredDescription
- is_controlbooleanrequiredDescription
- control_allocationrequiredDescription
- experience_typestringrequiredDescription
- has_targetsbooleanrequiredDescription
- tagsstring[]requiredDescription
- metaMetaExample
{ "code": 200, "errors": [], "warnings": [], "monetateId": "monetate id" }Description- codeintegerDescription
- errorsobject[]Description
- monetateIdstringDescription
- warningsobject[]
curl
curl --request POST \
--url https://engine.monetate.net/api/engine/v1/decide/{retailerShortname} \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"events": [
{
"eventType": ""
}
]
}'php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://engine.monetate.net/api/engine/v1/decide/{retailerShortname}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"events": [
{
"eventType": ""
}
]
}',
CURLOPT_HTTPHEADER => array(
'accept: application/json',
'content-type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"events": [
{
"eventType": ""
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://engine.monetate.net/api/engine/v1/decide/{retailerShortname}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));python
import requests
import json
url = "https://engine.monetate.net/api/engine/v1/decide/{retailerShortname}"
payload = json.dumps({
"events": [
{
"eventType": ""
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
ruby
require "uri"
require "json"
require "net/http"
url = URI("https://engine.monetate.net/api/engine/v1/decide/{retailerShortname}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"events": [
{
"eventType": ""
}
]
})
response = https.request(request)
puts response.read_body
200
// The request was succesful and the payload will include valid actions.
{
"data": {
"responses": [
{
"requestId": "",
"actions": [
{
"actionType": "",
"impressionId": "",
"impressionReporting": [
{
"experience_id": 0,
"experience_label": "",
"experience_name": "",
"variant_label": "",
"is_control": false,
"control_allocation": "",
"experience_type": "",
"has_targets": false,
"tags": [
""
]
}
]
}
]
}
]
},
"meta": {
"code": 0,
"errors": [
{}
],
"monetateId": "",
"warnings": [
{}
]
}
}400
// Invalid request.
The request was either malformated (did not follow this specification), or the data sent was invalid.
{
"data": {
"responses": [
{
"requestId": "",
"actions": [
{
"actionType": "",
"impressionId": "",
"impressionReporting": [
{
"experience_id": 0,
"experience_label": "",
"experience_name": "",
"variant_label": "",
"is_control": false,
"control_allocation": "",
"experience_type": "",
"has_targets": false,
"tags": [
""
]
}
]
}
]
}
]
},
"meta": {
"code": 0,
"errors": [
{}
],
"monetateId": "",
"warnings": [
{}
]
}
}