{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Query 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": "Query Configurations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Query Configuration for a Solution",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/query",
            "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": "acmecorporation_ca",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "solutionType",
                "value": "",
                "type": "query",
                "description": "The solution type for the rule. It can be either 'listing' or 'search' or 'recommendations'."
              },
              {
                "name": "targets",
                "value": "Surf With Us This Year",
                "type": "query",
                "description": "List of target identifiers e.g. listing page name, slot ID"
              },
              {
                "name": "isGlobal",
                "value": "",
                "type": "query",
                "description": "Whether the query configuration is globally applied."
              }
            ]
          },
          "docs": "Retrieves the query configuration for a solution (e.g. listing, search) in an [organization](https://docs.coveo.com/en/185/). <br/><br/><b>Note:</b> When using the Recommendation solution type, only the `perPage` and `additionalFields` parameters within the query configuration model are supported.</br></br>**Required privilege:** Merchandising Hub - View<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"VIEW\",\"targetId\":\""
        },
        {
          "info": {
            "name": "Create Query Configuration for a Solution",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/query",
            "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 query configuration for a solution (e.g. listing, search) in an [organization](https://docs.coveo.com/en/185/). <br/><br/><b>Note:</b> When using the Recommendation solution type, only the `perPage` and `additionalFields` parameters within the query configuration model are supported</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"
        },
        {
          "info": {
            "name": "Update Query Configuration for a Solution",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/query",
            "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": "Updates a query configuration for a solution (e.g. listing, search) in an [organization](https://docs.coveo.com/en/185/). <br/><br/><b>Note:</b> When using the Recommendation solution type, only the `perPage` and `additionalFields` parameters within the query configuration model are supported.</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{bod"
        },
        {
          "info": {
            "name": "Delete the Query Configuration of a Solution",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/commerce/v2/configurations/query",
            "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": "acmecorporation_ca",
                "type": "query",
                "description": "The unique identifier of the tracking target."
              },
              {
                "name": "solutionType",
                "value": "",
                "type": "query",
                "description": "The solution type for the rule. It can be either 'listing' or 'search' or 'recommendations'."
              },
              {
                "name": "targets",
                "value": "Surf With Us This Year",
                "type": "query",
                "description": "List of target identifiers e.g. listing page name, slot ID"
              },
              {
                "name": "isGlobal",
                "value": "",
                "type": "query",
                "description": "Whether the query configuration is globally applied."
              }
            ]
          },
          "docs": "Deletes a query configuration for a solution (e.g. listing, search) in an [organization](https://docs.coveo.com/en/185/). <br/><br/><b>Note:</b> When using the Recommendation solution type, only the `perPage` and `additionalFields` parameters within the query configuration model are supported.</br></br>**Required privilege:** Merchandising Hub - Edit<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"COMMERCE\",\"targetDomain\":\"MERCHANDISING_HUB\",\"type\":\"EDIT\",\"targetId\":\"{tra"
        }
      ]
    }
  ],
  "bundled": true
}