---
title: Get Experience Summary Details
slug: metadata-api/get-experience-summary-details
image: https://archbee-image-uploads.s3.amazonaws.com/ceIfEvQHzQk1IVxoRWUh7/K9eTL4jKm7UQINb6zNziJ-20250912-181225.png
docTags:
createdAt: 2024-06-26T17:38:51.912Z
---
{
"id": "JfK9cBZevFoXQUExqZ5ki",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}",
"servers": [
{
"url": "https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}"
}
],
"name": "Get Experience Summary Details",
"description": "Returns detailed summary information about a single experience.",
"contentType": "application/json",
"request": {
"pathParameters": [
{
"kind": "required",
"name": "experience-summary-id",
"type": "integer",
"description": "The identifier of a experience."
}
],
"headerParameters": [],
"queryParameters": [
{
"kind": "optional",
"name": "name",
"type": "string",
"description": "Case-insensitive query for the experience name. If the experience name contains the query value, it will be returned.
"
},
{
"kind": "optional",
"name": "page_size",
"type": "integer",
"description": "The number of items per response page. The default is 10, and the maximum is 1000; higher values will be clamped to the maximum.
"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "TokenAuthentication",
"name": "Authorization",
"kind": "optional",
"type": "apiKey",
"description": "The Monetate Metadata API uses Token Authentication. Requests to the Metadata API must include a valid, active authentication token. Include an Authorization header with the value Token [token_string] with every request. See Auth API for information on obtaining the token_string.
",
"in": "header"
}
]
},
"responses": [
{
"statusCode": "200",
"description": "A single Experience summary.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "Experience-SummaryResponse",
"schema": [
{
"name": "meta",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseMeta",
"customType": "ResponseMeta",
"schema": [
{
"name": "code",
"kind": "required",
"type": "integer",
"description": "The http response code for this response.",
"example": 200
},
{
"name": "warnings",
"kind": "optional",
"type": "array",
"description": "A list of warnings associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "A list of errors associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
}
]
},
{
"name": "data",
"kind": "required",
"type": "object",
"description": "Representation of an Experience summary object.",
"example": "{\"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\"}",
"modelRef": "#/components/schemas/Experience-Summary",
"customType": "Experience-Summary",
"schema": [
{
"name": "id",
"kind": "optional",
"type": "integer",
"readOnly": true,
"description": "Monetate internal identifier for experiences.",
"example": 0
},
{
"name": "account_domain",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "The account domain the experience is associated with.",
"example": ""
},
{
"name": "experience_name",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "The name of the experience.",
"example": ""
},
{
"name": "experience_type",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "The type of experience.",
"example": ""
},
{
"name": "archived",
"kind": "optional",
"type": "boolean",
"readOnly": true,
"description": "A boolean value of whether the experience is archived or not.",
"example": ""
},
{
"name": "create_time",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "The creation time of the experience.",
"example": ""
},
{
"name": "start_time",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "The time what which the experience was activated or scheduled to be activated.",
"example": ""
},
{
"name": "end_time",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "The time what which the experience ended or scheduled to end.",
"example": ""
},
{
"name": "status",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "The current status of the experience. Options include \"active\", \"draft\", \"paused\", \"scheduled\", \"ended\".",
"example": ""
},
{
"name": "splits",
"kind": "optional",
"type": "array",
"readOnly": true,
"description": "A list of split IDs which are part of the experience.",
"example": "",
"itemType": "integer",
"customType": "integer[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "tags",
"kind": "optional",
"type": "array",
"readOnly": true,
"description": "A list of the tags that have been given to the experience.",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "goals",
"kind": "optional",
"type": "array",
"readOnly": true,
"description": "A list of goals that have been given to the experience.",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "key",
"kind": "required",
"type": "string",
"description": "The unique key for the goal",
"example": ""
},
{
"name": "name",
"kind": "required",
"type": "string",
"description": "The short description of the goal",
"example": ""
},
{
"name": "description",
"kind": "required",
"type": "string",
"description": "The long description of the goal",
"example": ""
}
]
},
{
"name": "variant_splits",
"kind": "optional",
"type": "array",
"readOnly": true,
"description": "Variant attributes and their percentage splits",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "id",
"kind": "required",
"type": "integer",
"description": "Id of the variant. This matches one item in the splits list",
"example": 0
},
{
"name": "variant",
"kind": "required",
"type": "string",
"description": "Name of the variant. Conforms to ^(?:[A-Z]+|Experiment|Control)$ where Experiment is used when there is only one variant running and Control is used for the control splits",
"example": ""
},
{
"name": "split",
"kind": "required",
"type": "number",
"description": "Ratio for the split. Sum of all ratios for variants and the control = 1",
"example": ""
},
{
"name": "label",
"kind": "optional",
"type": "boolean",
"description": "Label given to the variant. Empty if not assigned",
"example": ""
},
{
"name": "is_control",
"kind": "optional",
"type": "string",
"description": "Indicates that this is the control group split",
"example": ""
},
{
"name": "allocations",
"kind": "optional",
"type": "array",
"readOnly": true,
"description": "Holds allocations to control groups",
"example": "",
"itemType": "object",
"customType": "object[]",
"schema": [
{
"name": "variant",
"kind": "optional",
"type": "string",
"description": "Name of the variant. When the group is a control group this conforms to ^[A-Z]+-Control$",
"example": ""
},
{
"name": "split",
"kind": "optional",
"type": "number",
"description": "Ratio for the control split. Sum of all ratios for control would sum up to the total control ratio",
"example": ""
},
{
"name": "label",
"kind": "optional",
"type": "string",
"description": "Label for the control. This is allways set the same as variant attribute",
"example": ""
},
{
"name": "split_id",
"kind": "optional",
"type": "integer",
"description": "Split id control belongs to",
"example": 0
}
]
}
]
},
{
"name": "integration_type",
"kind": "optional",
"type": "string",
"readOnly": true,
"description": "Experience type either client-side, email or engine-api.",
"example": ""
}
]
}
],
"modelRef": "#/components/schemas/Experience-SummaryResponse",
"isExpanded": true
}
]
},
{
"statusCode": "401",
"description": "Unauthorized. \n\nThe 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.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "Response",
"schema": [
{
"name": "meta",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseMeta",
"customType": "ResponseMeta",
"schema": [
{
"name": "code",
"kind": "required",
"type": "integer",
"description": "The http response code for this response.",
"example": 200
},
{
"name": "warnings",
"kind": "optional",
"type": "array",
"description": "A list of warnings associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "A list of errors associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
}
]
},
{
"name": "data",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseAnyData",
"customType": "ResponseAnyData",
"schema": []
}
],
"modelRef": "#/components/schemas/Response",
"isExpanded": true
}
]
},
{
"statusCode": "403",
"description": "Forbidden.\n\nThe request included a token that has been revoked. Please contact your account administrator to generate a new token.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "Response",
"schema": [
{
"name": "meta",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseMeta",
"customType": "ResponseMeta",
"schema": [
{
"name": "code",
"kind": "required",
"type": "integer",
"description": "The http response code for this response.",
"example": 200
},
{
"name": "warnings",
"kind": "optional",
"type": "array",
"description": "A list of warnings associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "A list of errors associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
}
]
},
{
"name": "data",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseAnyData",
"customType": "ResponseAnyData",
"schema": []
}
],
"modelRef": "#/components/schemas/Response",
"isExpanded": true
}
]
},
{
"statusCode": "404",
"description": "Not found.\n\nThe resource you are trying to fetch does not exist, or has been deleted.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "Response",
"schema": [
{
"name": "meta",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseMeta",
"customType": "ResponseMeta",
"schema": [
{
"name": "code",
"kind": "required",
"type": "integer",
"description": "The http response code for this response.",
"example": 200
},
{
"name": "warnings",
"kind": "optional",
"type": "array",
"description": "A list of warnings associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "A list of errors associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
}
]
},
{
"name": "data",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseAnyData",
"customType": "ResponseAnyData",
"schema": []
}
],
"modelRef": "#/components/schemas/Response",
"isExpanded": true
}
]
},
{
"statusCode": "500",
"description": "Unknown error.\n\nPlease try again or contact your account manager for more information.",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "",
"customType": "Response",
"schema": [
{
"name": "meta",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseMeta",
"customType": "ResponseMeta",
"schema": [
{
"name": "code",
"kind": "required",
"type": "integer",
"description": "The http response code for this response.",
"example": 200
},
{
"name": "warnings",
"kind": "optional",
"type": "array",
"description": "A list of warnings associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "errors",
"kind": "optional",
"type": "array",
"description": "A list of errors associated with this response.",
"example": "",
"itemType": "object",
"customType": "object[]",
"itemExample": "",
"itemDefault": ""
}
]
},
{
"name": "data",
"kind": "required",
"type": "object",
"description": "",
"modelRef": "#/components/schemas/ResponseAnyData",
"customType": "ResponseAnyData",
"schema": []
}
],
"modelRef": "#/components/schemas/Response",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "LgbX9mCURtEBh9Iepn3fX",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id} \\\n --header 'accept: application/json'"
},
{
"id": "jEapQYs0oTggLy6A-92dG",
"language": "php",
"label": "PHP",
"code": " 'https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'accept: application/json',\n 'content-type: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n"
},
{
"id": "Sfj6LFxXD3Y3KHuIIkFSv",
"language": "javascript",
"label": "JavaScript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "ZUoj8BXDBbiLt2F7q13XP",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
},
{
"id": "hZ0lcttq3Y4udlkombMaE",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.monetate.net/api/metadata/v1/{retailerShortname}/production/metadata/experience-summary/{experience-summary-id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
}
],
"selectedLanguageId": "LgbX9mCURtEBh9Iepn3fX"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// A single Experience summary.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {\n \"id\": 0,\n \"account_domain\": \"\",\n \"experience_name\": \"\",\n \"experience_type\": \"\",\n \"archived\": false,\n \"create_time\": \"\",\n \"start_time\": \"\",\n \"end_time\": \"\",\n \"status\": \"\",\n \"splits\": [\n 0\n ],\n \"tags\": [\n \"\"\n ],\n \"goals\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"variant_splits\": [\n {\n \"id\": 0,\n \"variant\": \"\",\n \"split\": 0,\n \"label\": false,\n \"is_control\": \"\",\n \"allocations\": [\n {\n \"variant\": \"\",\n \"split\": 0,\n \"label\": \"\",\n \"split_id\": 0\n }\n ]\n }\n ],\n \"integration_type\": \"\"\n }\n}"
},
{
"id": "response-1-401",
"language": "401",
"code": "// Unauthorized. \n\nThe 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.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}"
},
{
"id": "response-2-403",
"language": "403",
"code": "// Forbidden.\n\nThe request included a token that has been revoked. Please contact your account administrator to generate a new token.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}"
},
{
"id": "response-3-404",
"language": "404",
"code": "// Not found.\n\nThe resource you are trying to fetch does not exist, or has been deleted.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}"
},
{
"id": "response-4-500",
"language": "500",
"code": "// Unknown error.\n\nPlease try again or contact your account manager for more information.\n{\n \"meta\": {\n \"code\": 200,\n \"warnings\": [\n {}\n ],\n \"errors\": [\n {}\n ]\n },\n \"data\": {}\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"id": "9Pmwjji7sQK7lazXQS4Gi",
"type": "paragraph",
"children": [
{
"text": "Returns detailed summary information about a single experience."
}
]
}
]
}