{
"opencollection": "1.0.0",
"info": {
"name": "Coveo Activity Activities Context Mapping Configurations API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"items": [
{
"info": {
"name": "Context Mapping Configurations",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Context Mapping",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings/:key",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`"
},
{
"name": "trackingId",
"value": "",
"type": "path",
"description": "The unique identifier of the tracking target."
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The context mapping key"
}
]
},
"docs": "Gets a specific context mapping by key.**Required privilege:** Merchandising Hub - View
Privilege required
\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Update Context Mapping",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings/:key",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`"
},
{
"name": "trackingId",
"value": "",
"type": "path",
"description": "The unique identifier of the tracking target."
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The context mapping key"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing context mapping by key**Required privilege:** Merchandising Hub - Edit
Privilege required
\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n "
},
{
"info": {
"name": "Delete Context Mapping",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings/:key",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`"
},
{
"name": "trackingId",
"value": "",
"type": "path",
"description": "The unique identifier of the tracking target."
},
{
"name": "key",
"value": "",
"type": "path",
"description": "The context mapping key"
}
]
},
"docs": "Deletes a specific context mapping by key.**Required privilege:** Merchandising Hub - Edit
Privilege required
\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n "
},
{
"info": {
"name": "List Context Mappings",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`"
},
{
"name": "trackingId",
"value": "",
"type": "path",
"description": "The unique identifier of the tracking target."
}
]
},
"docs": "Lists all context mapping configurations.**Required privilege:** Merchandising Hub - View
Privilege required
\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Creates a Context Mapping",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/tracking-ids/:trackingId/context-mappings",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `acmecorporation8tp8wu3`"
},
{
"name": "trackingId",
"value": "",
"type": "path",
"description": "The unique identifier of the tracking target."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a context mapping for a specific key.**Required privilege:** Merchandising Hub - Edit
Privilege required
\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n "
}
]
}
],
"bundled": true
}