{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Recommendations Configuration 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": "Recommendations Configuration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieves a Slot Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/:configurationId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/)."
              }
            ]
          },
          "docs": "Shows a [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update a Slot Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/:configurationId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{body.trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Deletes a Slot Configuration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/:configurationId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/)."
              }
            ]
          },
          "docs": "Deletes a [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves Slot Settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/:configurationId/settings",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/)."
              }
            ]
          },
          "docs": "Shows slot settings in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Slot Settings",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/:configurationId/settings",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates slot settings in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{body.trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves a Global Query Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/global/query-configuration",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              }
            ]
          },
          "docs": "Shows a Query configuration. in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update a Global Query Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/global/query-configuration",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a Query configuration. in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves All Slot Configurations of an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of [slot configurations](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              }
            ]
          },
          "docs": "Lists all the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create a Slot Configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{body.trackingId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves Available Slot Strategies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/:configurationId/strategies",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "configurationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/)."
              }
            ]
          },
          "docs": "Shows The available strategies to use for this slot. in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves Available Slot Strategies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/strategies",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "slotType",
                "value": "",
                "type": "query",
                "description": "A slot type label that identifies the location of a slot."
              },
              {
                "name": "seedType",
                "value": "",
                "type": "query",
                "description": "The primary [seed product](https://docs.coveo.com/en/n5jg0219/glossary/seed-product) type used by recommendations strategies on this [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/). One of: product, cart or purchased."
              }
            ]
          },
          "docs": "Shows The available strategies to use for this slot. in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Retrieves All Slot Configuration Ids & Names of an Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/recommendations/slots/names",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `acmecorporation8tp8wu3`"
              },
              {
                "name": "trackingId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "query",
                "value": "slotName",
                "type": "query",
                "description": "Filter on names when requesting slot names & IDs. Will perform '*query*' match pattern."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based index number of the page of [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) to retrieve.</br>**Minimum:** `0`</br>**Default:** `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of [slot configurations](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) to list per page.</br>**Minimum:** `1`</br>**Maximum:** `1000`</br>**Default:** `10`"
              }
            ]
          },
          "docs": "Lists all the names of the [slot configuration](https://docs.coveo.com/en/o9b80563/glossary/recommendation-slot/) in an [organization](https://docs.coveo.com/en/185/).</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}