{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Insight Panel 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": "Insight Panel",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Insight Panel Configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightconfig/v1/configs",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of configurations to list."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of configurations to list per page. Must be equal to or greater than <code>1</code>."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter that only retrieves matching Insight Panel configurations."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>: items are sorted in descending order.</li> </ul>"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Gets a list of Insight Panel configurations."
        },
        {
          "info": {
            "name": "Create an Insight Panel Configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightconfig/v1/configs",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Creates a new Insight Panel configuration."
        },
        {
          "info": {
            "name": "List Insight Panel Configurations by Ids.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightconfig/v1/configs/ids",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of configurations to list."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of configurations to list per page. Must be equal to or greater than <code>1</code>."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter that only retrieves matching Insight Panel configurations."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>: items are sorted in descending order.</li> </ul>"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Gets a list of Insight Panel configurations by ids."
        },
        {
          "info": {
            "name": "Get an Insight Panel Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightconfig/v1/configs/:configId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel configuration."
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Gets a single Insight Panel configuration."
        },
        {
          "info": {
            "name": "Update an Insight Panel Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightconfig/v1/configs/:configId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel configuration."
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Updates an existing Insight Panel configuration."
        },
        {
          "info": {
            "name": "Delete an Insight Panel Configuration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightconfig/v1/configs/:configId",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel configuration."
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Deletes an existing Insight Panel configuration."
        },
        {
          "info": {
            "name": "Get an Insight Panel Interface",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insight/v1/configs/:configId/interface",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel configuration."
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Gets a specific Insight Panel interface."
        },
        {
          "info": {
            "name": "Search for Items",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insight/v1/configs/:configId/search",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Insight Panel configuration."
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Searches for items using a specific Insight Panel configuration."
        },
        {
          "info": {
            "name": "Retrieve Query Suggestions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insight/v1/configs/:configId/querysuggest",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the Insight Panel configuration."
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Retrieves query suggestions using a specific Insight Panel configuration."
        },
        {
          "info": {
            "name": "Retrieve Item Quickview",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insight/v1/configs/:configId/quickview",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "configId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel configuration."
              },
              {
                "name": "uniqueId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the target document."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "<p>The basic query expression, typically the keywords entered by the end user in a query box.</p> <p><strong>Note:</strong> When logging a <strong>Search</strong> Usage Analytics event for a query, the <code>queryText</code> field of that event should be set to the <code>q</code> value of the corresponding query.</p>"
              },
              {
                "name": "enableNavigation",
                "value": "",
                "type": "query",
                "description": "Provide controls to the end user for navigating through the matching keywords in the document."
              },
              {
                "name": "requestedOutputSize",
                "value": "",
                "type": "query",
                "description": "The approximate number of bytes to request in the HTML response. <strong>Default:</strong> <code>0</code>, meaning that the entire HTML document is requested."
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Retrieves an item Quickview using a specific Insight Panel configuration."
        },
        {
          "info": {
            "name": "Get Insight Configurations by Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightconfig/v1/configs/projects/get",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br /><b>Example:</b> `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the project for which to retrieve insight panel configurations."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of configurations to list.<br /><b>Default:</b> `0`"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The maximum number of configurations to include per page.<br /><b>Default:</b> `100`"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A filter that only retrieves matching Insight Panel configurations."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The order in which the configurations are listed. The available values are: <ul> <li><i>empty</i>: items are not sorted in any specific order.</li> <li><code>asc</code>: items are sorted in ascending order.</li> <li><code>desc</code>: items are sorted in descending order.</li> </ul>"
              }
            ],
            "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}}"
              }
            }
          },
          "docs": "Retrieves insight panel configurations associated with a specific project in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).<br /><br /><b>Required privilege:</b> Customer Service - Insight panel configuration - View"
        },
        {
          "info": {
            "name": "Get All Insight Panel Interfaces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "filter",
                "value": "Store",
                "type": "query",
                "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of configurations to list."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The maximum number of configurations to include per page."
              }
            ]
          },
          "docs": "Get all [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interfaces in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Create an Insight Panel Interface",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get an Insight Panel Interface",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel interface."
              }
            ]
          },
          "docs": "Get an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Update an Insight Panel Interface",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel interface."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Delete an Insight Panel Interface",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel interface."
              }
            ]
          },
          "docs": "Delete an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get Versions for an Insight Panel Interface",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel interface."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of versions to list."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of versions to include per page."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A substring that must appear in a version label for this version to appear in results."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The sort direction of the versions based on the version number.<br />Possible values:<br /> - `asc`: ascending order<br /> - `desc`: descending order"
              }
            ]
          },
          "docs": "Get a list of versions of the [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface of a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get an Insight Panel Interface Version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel interface."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "The sequential number identifying a version."
              }
            ]
          },
          "docs": "Get information about a specific version of an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface."
        },
        {
          "info": {
            "name": "Restore an Insight Panel Interface Version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber/restore",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel interface."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "The sequential number identifying a version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore the current [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface to a specific version."
        },
        {
          "info": {
            "name": "Update an Insight Panel Interface Version Label",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber/label",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target Insight Panel interface."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "The sequential number identifying a version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the label for a specific [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface version."
        }
      ]
    }
  ],
  "bundled": true
}