Get Experience Summary Details
GET
https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}
Path Parameters
- experience-summary-idintegerrequiredDescription
Query Parameters
- namestringDescription
- page_sizeintegerDescription
Responses
200
- Experience-SummaryResponse
- metaResponseMetarequired
- codeintegerrequiredExampleDescription
- warningsobject[]Description
- errorsobject[]Description
- dataExperience-SummaryrequiredExample
{ "id": 123456, "account_domain": "website.com", "archived": false, "create_time": "YYYY-MM-DDTHH:MM:SS.000000Z", "end_time": "YYYY-MM-DDTHH:MM:SS.000000Z", "experience_name": "example experience name", "experience_type": "experience", "start_time": "YYYY-MM-DDTHH:MM:SS.000000Z", "status": "active", "splits": [ 98765, 54322 ], "tags": [ "tag1", "tag2" ], "goals": [ { "key": "newcustomer", "name": "New customer acquisition rate", "description": "Conversion rate for new customers - sessions with purchase for new customers / number of sessions for new customers" } ], "variant_splits": [ { "id": 98765, "variant": "A", "split": 0.266, "label": "dfgdfg" }, { "id": 54322, "variant": "B", "split": 0.267, "label": "" }, { "variant": "Control", "is_control": true, "split": 0.2, "allocations": [ { "variant": "A-Control", "split": 0.0665, "label": "A-Control", "split_id": 98765 }, { "variant": "B-Control", "split": 0.0668, "label": "B-Control", "split_id": 54322 } ] }, { "variant": "Holdout", "is_holdout": true, "split": 0.2, "allocations": [ { "variant": "Experiment (Holdout)", "split": 0.1, "label": "Experiment (Holdout)", "test_group": 3, "split_id": 2345583 }, { "variant": "Baseline (Holdout)", "split": 0.1, "label": "Baseline (Holdout)", "test_group": 2, "split_id": 2345584 } ] } ], "integration_type": "js-tag" }Description- idintegerDescription
- account_domainstringDescription
- experience_namestringDescription
- experience_typestringDescription
- archivedbooleanDescription
- create_timestringDescription
- start_timestringDescription
- end_timestringDescription
- statusstringDescription
- splitsinteger[]Description
- tagsstring[]Description
- goalsobject[]Description
- keystring<ag_customer_session_count_1d | ag_customer_session_count_30d | ag_customer_session_count_7d | ag_session_count_1d | ag_session_count_30d | ag_session_count_7d | ag_unique_customer_mids_1d | ag_unique_customer_mids_30d | ag_unique_customer_mids_7d | ag_unique_customers_1d | ag_unique_customers_30d | ag_unique_customers_7d | ag_unique_mids_1d | ag_unique_mids_30d | ag_unique_mids_7d | avg_page_views | avg_time_on_site | bounce_rate | buyers | buyfreq | cartabandon | control_group | control_totalsales | conversion | customer_conversion_30d | customer_conversion_7d | customer_revenue_30d | customer_revenue_7d | customer_session_count_30d | customer_session_count_7d | email_ctr | experiment_group | experiment_totalsales | newcustomer | order_contribution | ordervalue | realordervalue | session_contribution | session_count_30d | session_count_7d | session_value | total_visitors | totalsales | unique_conversion | unique_customer_count_daily | unique_customer_mids_30d | unique_customer_mids_7d | unique_customer_mids_daily | unique_customer_sessions_daily | unique_customers_30d | unique_customers_7d | unique_mids_30d | unique_mids_7d | units_per_transaction | url_event | visitfreq | ^page_event_\d+$ | ^action_event_\d +$>requiredDescription
- namestringrequiredDescription
- descriptionstringrequiredDescription
- variant_splitsobject[]Description
- idintegerrequiredDescription
- variantstringrequiredDescription
- splitnumberrequiredDescription
- labelbooleanDescription
- is_controlstringDescription
- allocationsobject[]Description
- variantstringDescription
- splitnumberDescription
- labelstringDescription
- split_idintegerDescription
- integration_typestring<js-tag | engine-api | email>Description
401
- Response
- metaResponseMetarequired
- codeintegerrequiredExampleDescription
- warningsobject[]Description
- errorsobject[]Description
- dataResponseAnyDatarequired
403
- Response
- metaResponseMetarequired
- codeintegerrequiredExampleDescription
- warningsobject[]Description
- errorsobject[]Description
- dataResponseAnyDatarequired
404
- Response
- metaResponseMetarequired
- codeintegerrequiredExampleDescription
- warningsobject[]Description
- errorsobject[]Description
- dataResponseAnyDatarequired
500
- Response
- metaResponseMetarequired
- codeintegerrequiredExampleDescription
- warningsobject[]Description
- errorsobject[]Description
- dataResponseAnyDatarequired
curl
curl --request GET \
--url https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id} \
--header 'accept: application/json'php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
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 requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));python
import requests
import json
url = "https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
200
// A single Experience summary.
{
"meta": {
"code": 200,
"warnings": [
{}
],
"errors": [
{}
]
},
"data": {
"id": 0,
"account_domain": "",
"experience_name": "",
"experience_type": "",
"archived": false,
"create_time": "",
"start_time": "",
"end_time": "",
"status": "",
"splits": [
0
],
"tags": [
""
],
"goals": [
{
"key": "",
"name": "",
"description": ""
}
],
"variant_splits": [
{
"id": 0,
"variant": "",
"split": 0,
"label": false,
"is_control": "",
"allocations": [
{
"variant": "",
"split": 0,
"label": "",
"split_id": 0
}
]
}
],
"integration_type": ""
}
}401
// Unauthorized.
The request did not include a token, or the token provided was invalid. Please ensure that your token is correct and that the Authorization header is properly formatted.
{
"meta": {
"code": 200,
"warnings": [
{}
],
"errors": [
{}
]
},
"data": {}
}403
// Forbidden.
The request included a token that has been revoked. Please contact your account administrator to generate a new token.
{
"meta": {
"code": 200,
"warnings": [
{}
],
"errors": [
{}
]
},
"data": {}
}404
// Not found.
The resource you are trying to fetch does not exist, or has been deleted.
{
"meta": {
"code": 200,
"warnings": [
{}
],
"errors": [
{}
]
},
"data": {}
}500
// Unknown error.
Please try again or contact your account manager for more information.
{
"meta": {
"code": 200,
"warnings": [
{}
],
"errors": [
{}
]
},
"data": {}
}Returns detailed summary information about a single experience.