{ "info": { "_postman_id": "52d919d0-fcf7-408d-9c6c-5d34fec47d25", "name": "Coveo Activity Activities Insight Panel API", "description": "API for Coveo Platform\n\nContact Support:\n Name: Coveo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "lastUpdatedBy": "35240", "uid": "35240-52d919d0-fcf7-408d-9c6c-5d34fec47d25" }, "item": [ { "name": "rest", "item": [ { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "insightconfig", "item": [ { "name": "v1", "item": [ { "name": "configs", "item": [ { "name": "ids", "item": [ { "name": "List Insight Panel Configurations by Ids.", "id": "67313de2-5120-403d-b661-eb9dd8b26bea", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/ids?page=0&perPage=10&filter=&order=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", "ids" ], "query": [ { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "0" }, { "description": "The number of configurations to list per page. Must be equal to or greater than 1.", "key": "perPage", "value": "10" }, { "description": "A filter that only retrieves matching Insight Panel configurations.", "key": "filter", "value": "" }, { "description": "The order in which the configurations are listed. The available values are:
  • empty: items are not sorted in any specific order.
  • asc: items are sorted in ascending order.
  • desc: items are sorted in descending order.
", "key": "order", "value": "" } ], "variable": [ { "id": "c148bd58-6aff-4b7e-b11f-1a9977db80b7", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Gets a list of Insight Panel configurations by ids." }, "response": [ { "id": "9a8db7ac-bb95-47cb-b90a-7817d863b0cf", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"\",\n \"\"\n ]\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/ids?page=0&perPage=10&filter=&order=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", "ids" ], "query": [ { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "0" }, { "description": "The number of configurations to list per page. Must be equal to or greater than 1.", "key": "perPage", "value": "10" }, { "description": "A filter that only retrieves matching Insight Panel configurations.", "key": "filter", "value": "" }, { "description": "The order in which the configurations are listed. The available values are:
  • empty: items are not sorted in any specific order.
  • asc: items are sorted in ascending order.
  • desc: items are sorted in descending order.
", "key": "order", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-9a8db7ac-bb95-47cb-b90a-7817d863b0cf" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-67313de2-5120-403d-b661-eb9dd8b26bea" } ], "id": "0251f3a8-7d42-4bb9-b605-75ee36666ae6", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-0251f3a8-7d42-4bb9-b605-75ee36666ae6" }, { "name": "{configId}", "item": [ { "name": "Get an Insight Panel Configuration", "id": "f3104139-b2c0-4b61-88dd-e0806e4f2d21", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "id": "c20c92f1-0f29-442b-b991-e2bfb00c2007", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "a49d0599-86bc-4a5a-aa3c-45bac0a62eed", "key": "configId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel configuration." } ] }, "description": "Gets a single Insight Panel configuration." }, "response": [ { "id": "0e92981b-6ee5-4013-b317-a2b5d62f97a6", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-0e92981b-6ee5-4013-b317-a2b5d62f97a6" }, { "id": "b41eb36a-c6e1-4f14-8743-f9081c67d181", "name": "When the specified Insight Panel configuration does not exist.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-b41eb36a-c6e1-4f14-8743-f9081c67d181" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-f3104139-b2c0-4b61-88dd-e0806e4f2d21" }, { "name": "Update an Insight Panel Configuration", "id": "246874c7-daa3-479d-933b-e2c9e8a95e8c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"contextFields\": {},\n \"interfaces\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"pipeline\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "id": "c5164b7f-4081-4f15-870d-173959948d39", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "d0c2908b-6a4a-44d9-9a20-663696c900dd", "key": "configId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel configuration." } ] }, "description": "Updates an existing Insight Panel configuration." }, "response": [ { "id": "d9ff4ef5-cf52-4a34-9b29-b396fdf8eaa3", "name": "200 response", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contextFields\": {},\n \"interfaces\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"pipeline\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-d9ff4ef5-cf52-4a34-9b29-b396fdf8eaa3" }, { "id": "602bc511-91b3-4747-9caf-9265e7fca583", "name": "When the specified Insight Panel configuration does not exist.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"contextFields\": {},\n \"interfaces\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"pipeline\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-602bc511-91b3-4747-9caf-9265e7fca583" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-246874c7-daa3-479d-933b-e2c9e8a95e8c" }, { "name": "Delete an Insight Panel Configuration", "id": "9c2e76a7-3164-426f-b3ac-14e9f73cc237", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "id": "e9be4341-09ff-4406-9e0f-47b9d221e232", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "e25700a6-9e3a-4a04-bf61-88c1d1c17410", "key": "configId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel configuration." } ] }, "description": "Deletes an existing Insight Panel configuration." }, "response": [ { "id": "f41bdd83-5f47-4c58-935d-b6db85e2d9e5", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-f41bdd83-5f47-4c58-935d-b6db85e2d9e5" }, { "id": "d9eafaf9-bcf3-4ee0-9476-1698201cac4a", "name": "When the specified Insight Panel configuration does not exist.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/:configId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", ":configId" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-d9eafaf9-bcf3-4ee0-9476-1698201cac4a" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-9c2e76a7-3164-426f-b3ac-14e9f73cc237" } ], "id": "5ce7edcd-e408-4794-a199-f7764f6a99bb", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-5ce7edcd-e408-4794-a199-f7764f6a99bb" }, { "name": "projects", "item": [ { "name": "get", "item": [ { "name": "Get Insight Configurations by Project", "id": "d641401d-8947-4fc1-8142-c539d2060c78", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/projects/get?projectId=&page=&perPage=&filter=&order=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", "projects", "get" ], "query": [ { "description": "(Required) The unique identifier of the project for which to retrieve insight panel configurations.", "key": "projectId", "value": "" }, { "description": "The 0-based number of the page of configurations to list.
Default: `0`", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.
Default: `100`", "key": "perPage", "value": "" }, { "description": "A filter that only retrieves matching Insight Panel configurations.", "key": "filter", "value": "" }, { "description": "The order in which the configurations are listed. The available values are:
  • empty: items are not sorted in any specific order.
  • asc: items are sorted in ascending order.
  • desc: items are sorted in descending order.
", "key": "order", "value": "" } ], "variable": [ { "id": "4d267cb4-00f9-4d28-b170-62e07b691f90", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Retrieves insight panel configurations associated with a specific project in a [Coveo Cloud organization](https://docs.coveo.com/en/185/).

Required privilege: Customer Service - Insight panel configuration - View" }, "response": [ { "id": "c8183186-ffe8-4292-8f5c-6fcbebfe797c", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs/projects/get?projectId=&page=&perPage=&filter=&order=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs", "projects", "get" ], "query": [ { "description": "(Required) The unique identifier of the project for which to retrieve insight panel configurations.", "key": "projectId", "value": "" }, { "description": "The 0-based number of the page of configurations to list.
Default: `0`", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.
Default: `100`", "key": "perPage", "value": "" }, { "description": "A filter that only retrieves matching Insight Panel configurations.", "key": "filter", "value": "" }, { "description": "The order in which the configurations are listed. The available values are:
  • empty: items are not sorted in any specific order.
  • asc: items are sorted in ascending order.
  • desc: items are sorted in descending order.
", "key": "order", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"configurations\": [\n {\n \"projectIds\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n },\n {\n \"projectIds\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-c8183186-ffe8-4292-8f5c-6fcbebfe797c" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-d641401d-8947-4fc1-8142-c539d2060c78" } ], "id": "0ad841bc-f722-4bd8-bffd-6a215699d534", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-0ad841bc-f722-4bd8-bffd-6a215699d534" } ], "id": "6ff8f1d6-a943-4a97-808e-43cc79d09754", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-6ff8f1d6-a943-4a97-808e-43cc79d09754" }, { "name": "List Insight Panel Configurations", "id": "815d12e1-e543-4e09-994a-4e7e2ef5034e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs?page=0&perPage=10&filter=&order=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs" ], "query": [ { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "0" }, { "description": "The number of configurations to list per page. Must be equal to or greater than 1.", "key": "perPage", "value": "10" }, { "description": "A filter that only retrieves matching Insight Panel configurations.", "key": "filter", "value": "" }, { "description": "The order in which the configurations are listed. The available values are:
  • empty: items are not sorted in any specific order.
  • asc: items are sorted in ascending order.
  • desc: items are sorted in descending order.
", "key": "order", "value": "" } ], "variable": [ { "id": "70ed36c3-83ff-4394-9ef1-17e8eeacc4d8", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Gets a list of Insight Panel configurations." }, "response": [ { "id": "79c64e5a-3015-4a9e-8879-dc2c8fd93c87", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs?page=0&perPage=10&filter=&order=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs" ], "query": [ { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "0" }, { "description": "The number of configurations to list per page. Must be equal to or greater than 1.", "key": "perPage", "value": "10" }, { "description": "A filter that only retrieves matching Insight Panel configurations.", "key": "filter", "value": "" }, { "description": "The order in which the configurations are listed. The available values are:
  • empty: items are not sorted in any specific order.
  • asc: items are sorted in ascending order.
  • desc: items are sorted in descending order.
", "key": "order", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-79c64e5a-3015-4a9e-8879-dc2c8fd93c87" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-815d12e1-e543-4e09-994a-4e7e2ef5034e" }, { "name": "Create an Insight Panel Configuration", "id": "80d91cd5-ac83-41cc-a5f9-46efa1e6feaf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"pipeline\": \"\",\n \"contextFields\": {},\n \"interfaces\": [\n \"\",\n \"\"\n ]\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs" ], "variable": [ { "id": "b33ab514-e0d1-45a7-8e00-aea84260b885", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" } ] }, "description": "Creates a new Insight Panel configuration." }, "response": [ { "id": "2018b067-27b9-4f2e-b9a5-e928e3e8527d", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"pipeline\": \"\",\n \"contextFields\": {},\n \"interfaces\": [\n \"\",\n \"\"\n ]\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightconfig/v1/configs", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightconfig", "v1", "configs" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"pipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"models\": {\n \"art\": {\n \"enabled\": \"\"\n },\n \"dne\": {\n \"enabled\": \"\"\n },\n \"qs\": {\n \"enabled\": \"\"\n }\n }\n },\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interfaces\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-2018b067-27b9-4f2e-b9a5-e928e3e8527d" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-80d91cd5-ac83-41cc-a5f9-46efa1e6feaf" } ], "id": "16b40344-353a-4e9c-bc9e-f4d79b391b94", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-16b40344-353a-4e9c-bc9e-f4d79b391b94" } ], "id": "bc74152a-e7a1-4cfe-b68b-4457a3dc983b", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-bc74152a-e7a1-4cfe-b68b-4457a3dc983b" } ], "id": "7a444aea-e5a4-4b43-896c-6d00ff9b4c2f", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-7a444aea-e5a4-4b43-896c-6d00ff9b4c2f" }, { "name": "insight", "item": [ { "name": "v1", "item": [ { "name": "configs", "item": [ { "name": "{configId}", "item": [ { "name": "interface", "item": [ { "name": "Get an Insight Panel Interface", "id": "21613ce5-025c-450f-b7a3-6e0ca116dd0c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "*/*" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/interface", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "interface" ], "variable": [ { "id": "eb7ed5d2-6d4d-42e5-8514-660a15f11b07", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "41bdc445-5e9e-4c70-99ed-cb00a16f0c1c", "key": "configId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel configuration." } ] }, "description": "Gets a specific Insight Panel interface." }, "response": [ { "id": "a4c9f845-626a-4b39-8a70-60e95599052d", "name": "200 response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/interface", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "interface" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"contextFields\": {},\n \"searchHub\": \"\",\n \"interface\": {\n \"id\": \"\",\n \"name\": \"\",\n \"resultTemplates\": [\n {\n \"name\": \"\",\n \"layout\": \"default\",\n \"badge\": {\n \"field\": \"\",\n \"label\": \"\",\n \"color\": \"\"\n },\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"resultActions\": {\n \"attachToCase\": {\n \"enabled\": \"\"\n },\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n },\n \"sendAsEmail\": {\n \"enabled\": \"\"\n },\n \"sendToFeed\": {\n \"enabled\": \"\"\n }\n }\n },\n {\n \"name\": \"\",\n \"layout\": \"default\",\n \"badge\": {\n \"field\": \"\",\n \"label\": \"\",\n \"color\": \"\"\n },\n \"details\": [\n {\n \"field\": \"\",\n \"label\": \"\"\n },\n {\n \"field\": \"\",\n \"label\": \"\"\n }\n ],\n \"resultActions\": {\n \"attachToCase\": {\n \"enabled\": \"\"\n },\n \"copyToClipboard\": {\n \"enabled\": \"\"\n },\n \"quickView\": {\n \"enabled\": \"\"\n },\n \"sendAsEmail\": {\n \"enabled\": \"\"\n },\n \"sendToFeed\": {\n \"enabled\": \"\"\n }\n }\n }\n ],\n \"facets\": [\n {\n \"field\": \"\",\n \"label\": \"\",\n \"displayValuesAs\": \"checkbox\"\n },\n {\n \"field\": \"\",\n \"label\": \"\",\n \"displayValuesAs\": \"checkbox\"\n }\n ],\n \"tabs\": [\n {\n \"label\": \"\"\n },\n {\n \"label\": \"\"\n }\n ],\n \"settings\": {\n \"createArticle\": {\n \"enabled\": \"\"\n },\n \"fullSearch\": {\n \"enabled\": \"\"\n }\n }\n }\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-a4c9f845-626a-4b39-8a70-60e95599052d" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-21613ce5-025c-450f-b7a3-6e0ca116dd0c" } ], "id": "624f7ac0-0489-4b13-8294-63498f38cda2", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-624f7ac0-0489-4b13-8294-63498f38cda2" }, { "name": "search", "item": [ { "name": "Search for Items", "id": "1d4e581e-c353-4ae7-aca0-069d3477b8c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"\",\n \"userId\": \"\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {},\n \"configId\": \"\",\n \"source\": [\n \"\",\n \"\"\n ]\n },\n \"q\": \"\",\n \"cq\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"type\": \"specific\"\n },\n {\n \"field\": \"\",\n \"type\": \"specific\"\n }\n ],\n \"firstResult\": \"\",\n \"numberOfResults\": \"\",\n \"caseContext\": {},\n \"fieldsToInclude\": [\n \"\",\n \"\"\n ],\n \"enableDidYouMean\": false,\n \"sortCriteria\": \"relevancy\",\n \"tab\": \"\",\n \"debug\": false\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/search", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "search" ], "variable": [ { "id": "126326c8-7f6e-4a31-9d1a-892938e27e47", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "a0dfea73-0337-407c-8f81-f3d25547cd85", "key": "configId", "value": "", "description": "(Required) The unique identifier of the Insight Panel configuration." } ] }, "description": "Searches for items using a specific Insight Panel configuration." }, "response": [ { "id": "e2538eb3-9609-4496-9350-21053285527c", "name": "200 response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"\",\n \"userId\": \"\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {},\n \"configId\": \"\",\n \"source\": [\n \"\",\n \"\"\n ]\n },\n \"q\": \"\",\n \"cq\": \"\",\n \"facets\": [\n {\n \"field\": \"\",\n \"type\": \"specific\"\n },\n {\n \"field\": \"\",\n \"type\": \"specific\"\n }\n ],\n \"firstResult\": \"\",\n \"numberOfResults\": \"\",\n \"caseContext\": {},\n \"fieldsToInclude\": [\n \"\",\n \"\"\n ],\n \"enableDidYouMean\": false,\n \"sortCriteria\": \"relevancy\",\n \"tab\": \"\",\n \"debug\": false\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/search", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "search" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"totalCount\": \"\",\n \"totalCountFiltered\": \"\",\n \"duration\": \"\",\n \"indexDuration\": {},\n \"requestDuration\": \"\",\n \"searchUid\": \"\",\n \"pipeline\": \"\",\n \"apiVersion\": \"\",\n \"exception\": {\n \"code\": \"\",\n \"context\": \"\"\n },\n \"isFallbackToAdmin\": \"\",\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"errors\": [\n \"\",\n \"\"\n ],\n \"index\": \"\",\n \"indexToken\": \"\",\n \"triggers\": {\n \"type\": \"\",\n \"content\": {}\n },\n \"termsToHighlight\": {},\n \"phrasesToHighlight\": {},\n \"queryCorrections\": {\n \"correctedQuery\": \"\",\n \"wordCorrections\": [\n {\n \"offset\": \"\",\n \"length\": \"\",\n \"originalWord\": \"\",\n \"correctedWord\": \"\"\n },\n {\n \"offset\": \"\",\n \"length\": \"\",\n \"originalWord\": \"\",\n \"correctedWord\": \"\"\n }\n ]\n },\n \"refinedKeywords\": [\n \"\",\n \"\"\n ],\n \"categoryFacets\": [\n {\n \"field\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n },\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n }\n ],\n \"parentValues\": [\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n },\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n }\n ]\n },\n {\n \"field\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n },\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n }\n ],\n \"parentValues\": [\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n },\n {\n \"value\": \"\",\n \"numberOfResults\": \"\"\n }\n ]\n }\n ],\n \"facets\": [\n {\n \"field\": \"\",\n \"moreValuesAvailable\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"state\": \"idle\",\n \"numberOfResults\": \"\",\n \"endInclusive\": false,\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"moreValuesAvailable\": \"\",\n \"isSuggested\": \"\",\n \"isAutoSelected\": \"\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"isLeafValue\": \"\"\n },\n {\n \"value\": \"\",\n \"state\": \"idle\",\n \"numberOfResults\": \"\",\n \"endInclusive\": false,\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"moreValuesAvailable\": \"\",\n \"isSuggested\": \"\",\n \"isAutoSelected\": \"\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"isLeafValue\": \"\"\n }\n ],\n \"mlScore\": \"\",\n \"indexScore\": \"\",\n \"isFromAutoSelect\": \"\"\n },\n {\n \"field\": \"\",\n \"moreValuesAvailable\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"state\": \"idle\",\n \"numberOfResults\": \"\",\n \"endInclusive\": false,\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"moreValuesAvailable\": \"\",\n \"isSuggested\": \"\",\n \"isAutoSelected\": \"\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"isLeafValue\": \"\"\n },\n {\n \"value\": \"\",\n \"state\": \"idle\",\n \"numberOfResults\": \"\",\n \"endInclusive\": false,\n \"children\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"moreValuesAvailable\": \"\",\n \"isSuggested\": \"\",\n \"isAutoSelected\": \"\",\n \"path\": [\n \"\",\n \"\"\n ],\n \"isLeafValue\": \"\"\n }\n ],\n \"mlScore\": \"\",\n \"indexScore\": \"\",\n \"isFromAutoSelect\": \"\"\n }\n ],\n \"suggestedFacets\": [\n {\n \"field\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n },\n {\n \"value\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"field\": \"\",\n \"values\": [\n {\n \"value\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n },\n {\n \"value\": \"\",\n \"path\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"results\": [\n {\n \"title\": \"\",\n \"uri\": \"\",\n \"printableUri\": \"\",\n \"clickUri\": \"\",\n \"uniqueId\": \"\",\n \"excerpt\": \"\",\n \"firstSentences\": \"\",\n \"summary\": \"\",\n \"flags\": \"\",\n \"hasHtmlVersion\": \"\",\n \"hasMobileHtmlVersion\": \"\",\n \"score\": \"\",\n \"percentScore\": \"\",\n \"rankingInfo\": \"\",\n \"rating\": \"\",\n \"isTopResult\": \"\",\n \"isRecommendation\": \"\",\n \"isUserActionView\": \"\",\n \"rankingModifier\": \"\",\n \"titleHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"firstSentencesHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"excerptHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"printableUriHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"summaryHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"parentResult\": {\n \"value\": \"\"\n },\n \"childResults\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"totalNumberOfChildResults\": \"\",\n \"absentTerms\": [\n \"\",\n \"\"\n ],\n \"raw\": {}\n },\n {\n \"title\": \"\",\n \"uri\": \"\",\n \"printableUri\": \"\",\n \"clickUri\": \"\",\n \"uniqueId\": \"\",\n \"excerpt\": \"\",\n \"firstSentences\": \"\",\n \"summary\": \"\",\n \"flags\": \"\",\n \"hasHtmlVersion\": \"\",\n \"hasMobileHtmlVersion\": \"\",\n \"score\": \"\",\n \"percentScore\": \"\",\n \"rankingInfo\": \"\",\n \"rating\": \"\",\n \"isTopResult\": \"\",\n \"isRecommendation\": \"\",\n \"isUserActionView\": \"\",\n \"rankingModifier\": \"\",\n \"titleHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"firstSentencesHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"excerptHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"printableUriHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"summaryHighlights\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ],\n \"parentResult\": {\n \"value\": \"\"\n },\n \"childResults\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"totalNumberOfChildResults\": \"\",\n \"absentTerms\": [\n \"\",\n \"\"\n ],\n \"raw\": {}\n }\n ],\n \"questionAnswer\": {\n \"answerFound\": \"\",\n \"question\": \"\",\n \"answerSnippet\": \"\",\n \"answerId\": \"\",\n \"documentId\": {\n \"contentIdKey\": \"\",\n \"contentIdValue\": \"\"\n },\n \"allContentIds\": [\n {\n \"contentIdKey\": \"\",\n \"contentIdValue\": \"\"\n },\n {\n \"contentIdKey\": \"\",\n \"contentIdValue\": \"\"\n }\n ],\n \"score\": \"\",\n \"relatedQuestions\": [\n {\n \"question\": \"\",\n \"answerSnippet\": \"\",\n \"documentId\": {\n \"contentIdKey\": \"\",\n \"contentIdValue\": \"\"\n },\n \"score\": \"\"\n },\n {\n \"question\": \"\",\n \"answerSnippet\": \"\",\n \"documentId\": {\n \"contentIdKey\": \"\",\n \"contentIdValue\": \"\"\n },\n \"score\": \"\"\n }\n ],\n \"raw\": {}\n }\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-e2538eb3-9609-4496-9350-21053285527c" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-1d4e581e-c353-4ae7-aca0-069d3477b8c0" } ], "id": "bdda3d6e-589d-45cb-a3c0-3b47e36b2e49", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-bdda3d6e-589d-45cb-a3c0-3b47e36b2e49" }, { "name": "querysuggest", "item": [ { "name": "Retrieve Query Suggestions", "id": "31399f26-5a61-42d5-a48f-e57b51c572ef", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" } ], "body": { "mode": "raw", "raw": "{\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"\",\n \"userId\": \"\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {},\n \"configId\": \"\",\n \"source\": [\n \"\",\n \"\"\n ]\n },\n \"q\": \"\",\n \"count\": \"\",\n \"context\": {},\n \"locale\": \"\",\n \"timezone\": \"\",\n \"actionsHistory\": [\n {\n \"name\": \"\",\n \"time\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"time\": \"\",\n \"value\": \"\"\n }\n ],\n \"visitorId\": \"\",\n \"maximumAge\": \"\",\n \"debug\": false\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/querysuggest", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "querysuggest" ], "variable": [ { "id": "4f85acd0-323b-44cd-a717-ce4725af4e44", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "cc188883-a97f-474e-8f7b-656c53a2d85a", "key": "configId", "value": "", "description": "(Required) The unique identifier of the Insight Panel configuration." } ] }, "description": "Retrieves query suggestions using a specific Insight Panel configuration." }, "response": [ { "id": "cd5f13ff-cec1-4fa0-8c4e-25558ec857a6", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "*/*" }, { "key": "Accept", "value": "*/*" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"analytics\": {\n \"capture\": \"\",\n \"trackingId\": \"\",\n \"userId\": \"\",\n \"clientId\": \"\",\n \"documentLocation\": \"\",\n \"documentReferrer\": \"\",\n \"pageId\": \"\",\n \"userIp\": \"\",\n \"clientRequestId\": \"\",\n \"clientTimestamp\": \"\",\n \"userAgent\": \"\",\n \"actionCause\": \"\",\n \"originContext\": \"\",\n \"customData\": {},\n \"configId\": \"\",\n \"source\": [\n \"\",\n \"\"\n ]\n },\n \"q\": \"\",\n \"count\": \"\",\n \"context\": {},\n \"locale\": \"\",\n \"timezone\": \"\",\n \"actionsHistory\": [\n {\n \"name\": \"\",\n \"time\": \"\",\n \"value\": \"\"\n },\n {\n \"name\": \"\",\n \"time\": \"\",\n \"value\": \"\"\n }\n ],\n \"visitorId\": \"\",\n \"maximumAge\": \"\",\n \"debug\": false\n}" }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/querysuggest", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "querysuggest" ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "*/*" } ], "cookie": [], "responseTime": null, "body": "{\n \"completions\": [\n {\n \"expression\": \"\",\n \"score\": \"\",\n \"highlighted\": \"\",\n \"executableConfidence\": \"\",\n \"objectId\": \"\"\n },\n {\n \"expression\": \"\",\n \"score\": \"\",\n \"highlighted\": \"\",\n \"executableConfidence\": \"\",\n \"objectId\": \"\"\n }\n ],\n \"responseId\": \"\",\n \"executionReport\": {}\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-cd5f13ff-cec1-4fa0-8c4e-25558ec857a6" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-31399f26-5a61-42d5-a48f-e57b51c572ef" } ], "id": "999666bf-f2e4-4dca-8e8c-4c31334f21de", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-999666bf-f2e4-4dca-8e8c-4c31334f21de" }, { "name": "quickview", "item": [ { "name": "Retrieve Item Quickview", "id": "deaedc4c-1649-4770-b17d-a62462d05c0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/quickview?uniqueId=&q=&enableNavigation=&requestedOutputSize=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "quickview" ], "query": [ { "description": "(Required) The unique identifier of the target document.", "key": "uniqueId", "value": "" }, { "description": "

The basic query expression, typically the keywords entered by the end user in a query box.

Note: When logging a Search Usage Analytics event for a query, the queryText field of that event should be set to the q value of the corresponding query.

", "key": "q", "value": "" }, { "description": "Provide controls to the end user for navigating through the matching keywords in the document.", "key": "enableNavigation", "value": "" }, { "description": "The approximate number of bytes to request in the HTML response. Default: 0, meaning that the entire HTML document is requested.", "key": "requestedOutputSize", "value": "" } ], "variable": [ { "id": "7dc30ed9-64fa-4259-8cca-39ede9305e99", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
Example: `mycoveocloudv2organizationg8tp8wu3`" }, { "id": "ae1a39fc-cee8-447e-9044-734059434dce", "key": "configId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel configuration." } ] }, "description": "Retrieves an item Quickview using a specific Insight Panel configuration." }, "response": [ { "id": "47883c42-897f-4098-8b44-4880b57eb134", "name": "The item's HTML preview.", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insight/v1/configs/:configId/quickview?uniqueId=&q=&enableNavigation=&requestedOutputSize=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insight", "v1", "configs", ":configId", "quickview" ], "query": [ { "description": "(Required) The unique identifier of the target document.", "key": "uniqueId", "value": "" }, { "description": "

The basic query expression, typically the keywords entered by the end user in a query box.

Note: When logging a Search Usage Analytics event for a query, the queryText field of that event should be set to the q value of the corresponding query.

", "key": "q", "value": "" }, { "description": "Provide controls to the end user for navigating through the matching keywords in the document.", "key": "enableNavigation", "value": "" }, { "description": "The approximate number of bytes to request in the HTML response. Default: 0, meaning that the entire HTML document is requested.", "key": "requestedOutputSize", "value": "" } ], "variable": [ { "key": "organizationId" }, { "key": "configId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-47883c42-897f-4098-8b44-4880b57eb134" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-deaedc4c-1649-4770-b17d-a62462d05c0d" } ], "id": "44238483-14d7-4c1e-a8ed-080a2caee993", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-44238483-14d7-4c1e-a8ed-080a2caee993" } ], "id": "903d02b4-31a6-411c-a605-7973b822f4dc", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-903d02b4-31a6-411c-a605-7973b822f4dc" } ], "id": "6642da85-c83e-4bf8-ad95-889732c2c19b", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-6642da85-c83e-4bf8-ad95-889732c2c19b" } ], "id": "8e6b2d3f-aa19-4157-938b-77992eff3425", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-8e6b2d3f-aa19-4157-938b-77992eff3425" } ], "id": "bdf6f85d-fb28-47dd-b99b-c9b5ab08c530", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-bdf6f85d-fb28-47dd-b99b-c9b5ab08c530" }, { "name": "insightinterface", "item": [ { "name": "v1", "item": [ { "name": "interfaces", "item": [ { "name": "{interfaceId}", "item": [ { "name": "versions", "item": [ { "name": "{versionNumber}", "item": [ { "name": "restore", "item": [ { "name": "Restore an Insight Panel Interface Version", "id": "f3649e84-7187-435e-bd42-50eb79dd9b75", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber/restore", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions", ":versionNumber", "restore" ], "variable": [ { "id": "e1e92b34-6f48-433c-9114-7f48164153ea", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "916130e5-2df1-41ef-8944-a9d1513367e1", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel interface." }, { "id": "7613e4fb-e82b-47ca-ae42-c1cbef002275", "key": "versionNumber", "value": "", "description": "(Required) The sequential number identifying a version." } ] }, "description": "Restore the current [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface to a specific version." }, "response": [ { "id": "4c02b2e9-b3b4-432f-8a82-3c22194becb7", "name": "Ok", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber/restore", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions", ":versionNumber", "restore" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" }, { "key": "versionNumber" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "null", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-4c02b2e9-b3b4-432f-8a82-3c22194becb7" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-f3649e84-7187-435e-bd42-50eb79dd9b75" } ], "id": "a3be65e6-a38b-42ce-ae67-1294b6fae4ae", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-a3be65e6-a38b-42ce-ae67-1294b6fae4ae" }, { "name": "label", "item": [ { "name": "Update an Insight Panel Interface Version Label", "id": "c29957bf-b93c-4918-8eab-dbceb945d500", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber/label", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions", ":versionNumber", "label" ], "variable": [ { "id": "3884e690-031c-4ed7-b052-89cbe625764e", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "65131646-bf7b-4050-af2b-9bbafe67fad0", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel interface." }, { "id": "65ef88e6-2e8c-4d3c-b5e7-54edb58f3678", "key": "versionNumber", "value": "", "description": "(Required) The sequential number identifying a version." } ] }, "description": "Update the label for a specific [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface version." }, "response": [ { "id": "57f007ae-4072-444d-b501-bac7b9f54b60", "name": "Ok", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber/label", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions", ":versionNumber", "label" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" }, { "key": "versionNumber" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"version\": \"\",\n \"label\": \"\",\n \"created\": {\n \"by\": \"\",\n \"date\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"updated\": {\n \"by\": \"\",\n \"date\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"isPublished\": \"\",\n \"restoredFromVersion\": \"\"\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-57f007ae-4072-444d-b501-bac7b9f54b60" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-c29957bf-b93c-4918-8eab-dbceb945d500" } ], "id": "2fb5ad1c-7ca8-4e21-a81d-e795540b9588", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-2fb5ad1c-7ca8-4e21-a81d-e795540b9588" }, { "name": "Get an Insight Panel Interface Version", "id": "13accf1c-ac91-449b-a9b3-6c62d0218e70", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions", ":versionNumber" ], "variable": [ { "id": "65053b8f-9933-4193-af98-8ef96426f039", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "550be53e-f3ab-4e13-89c8-e429e324566d", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel interface." }, { "id": "92394aa6-1b08-45cc-94a8-5b6f34346b1f", "key": "versionNumber", "value": "", "description": "(Required) The sequential number identifying a version." } ] }, "description": "Get information about a specific version of an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface." }, "response": [ { "id": "e5224a84-50a3-4f94-9cdb-25b65acf59af", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions/:versionNumber", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions", ":versionNumber" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" }, { "key": "versionNumber" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #components/schemas/InsightInterfaceVersionInfo not found in the OpenAPI spec\"\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-e5224a84-50a3-4f94-9cdb-25b65acf59af" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-13accf1c-ac91-449b-a9b3-6c62d0218e70" } ], "id": "793a2a83-3e92-4b6b-b57b-e22bbf53dd97", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-793a2a83-3e92-4b6b-b57b-e22bbf53dd97" }, { "name": "Get Versions for an Insight Panel Interface", "id": "e37b9b6d-4439-4e5a-961a-a55ba2a92e9a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions?page=0&perPage=10&filter=&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions" ], "query": [ { "description": "The 0-based number of the page of versions to list.", "key": "page", "value": "0" }, { "description": "The number of versions to include per page.", "key": "perPage", "value": "10" }, { "description": "A substring that must appear in a version label for this version to appear in results.", "key": "filter", "value": "" }, { "description": "The sort direction of the versions based on the version number.
Possible values:
- `asc`: ascending order
- `desc`: descending order", "key": "order", "value": "desc" } ], "variable": [ { "id": "0a558173-c368-4144-8e78-360a51983913", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "1dab217b-8279-46b9-a875-e7a8fdd1c116", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel interface." } ] }, "description": "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/)." }, "response": [ { "id": "87fbb2cd-b084-4473-84f0-74187d5c8c0e", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId/versions?page=0&perPage=10&filter=&order=desc", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId", "versions" ], "query": [ { "description": "The 0-based number of the page of versions to list.", "key": "page", "value": "0" }, { "description": "The number of versions to include per page.", "key": "perPage", "value": "10" }, { "description": "A substring that must appear in a version label for this version to appear in results.", "key": "filter", "value": "" }, { "description": "The sort direction of the versions based on the version number.
Possible values:
- `asc`: ascending order
- `desc`: descending order", "key": "order", "value": "desc" } ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"totalPages\": \"\",\n \"totalEntries\": \"\",\n \"items\": [\n {\n \"version\": \"\",\n \"label\": \"\",\n \"created\": {\n \"by\": \"\",\n \"date\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"updated\": {\n \"by\": \"\",\n \"date\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"isPublished\": \"\",\n \"restoredFromVersion\": \"\"\n },\n {\n \"version\": \"\",\n \"label\": \"\",\n \"created\": {\n \"by\": \"\",\n \"date\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"updated\": {\n \"by\": \"\",\n \"date\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\"\n },\n \"isPublished\": \"\",\n \"restoredFromVersion\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-87fbb2cd-b084-4473-84f0-74187d5c8c0e" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-e37b9b6d-4439-4e5a-961a-a55ba2a92e9a" } ], "id": "cfd7ae03-1b9f-4aa0-8d04-cbcde9e09cd6", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-cfd7ae03-1b9f-4aa0-8d04-cbcde9e09cd6" }, { "name": "Get an Insight Panel Interface", "id": "aaa54b8e-204d-4359-993d-2d6fd1269d8a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId" ], "variable": [ { "id": "02efc6fd-5941-47b8-b793-545c3b4cab2d", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "7bf8a17e-0d20-43ac-8984-2f905b32fdc1", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel interface." } ] }, "description": "Get an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "7946b7d8-2d88-43f7-94c4-d1e54bbc83c2", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "null", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-7946b7d8-2d88-43f7-94c4-d1e54bbc83c2" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-aaa54b8e-204d-4359-993d-2d6fd1269d8a" }, { "name": "Update an Insight Panel Interface", "id": "7bdc748f-ae5a-4ab9-be62-fe66648789c2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "null", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId" ], "variable": [ { "id": "4e4ddc73-02ca-46c4-925f-bb53533d5f0a", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "03b01783-2de0-45cf-9ab9-545adf4785cb", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel interface." } ] }, "description": "Update an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "f26f3708-a39e-4b44-aae1-300ea74ace4e", "name": "Ok", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "null", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "null", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-f26f3708-a39e-4b44-aae1-300ea74ace4e" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-7bdc748f-ae5a-4ab9-be62-fe66648789c2" }, { "name": "Delete an Insight Panel Interface", "id": "14d3a827-80ad-4c3d-b302-2ef7eb583295", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId" ], "variable": [ { "id": "99b2c31d-d0aa-420d-93e8-99a2d0f72aaa", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." }, { "id": "6d7ee216-57be-48f7-81a3-18a8d81cce64", "key": "interfaceId", "value": "", "description": "(Required) The unique identifier of the target Insight Panel interface." } ] }, "description": "Delete an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "79a34a14-1cf7-4364-98b9-48e5c5c4137e", "name": "NoContent", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces/:interfaceId", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces", ":interfaceId" ], "variable": [ { "key": "organizationId" }, { "key": "interfaceId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-79a34a14-1cf7-4364-98b9-48e5c5c4137e" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-14d3a827-80ad-4c3d-b302-2ef7eb583295" } ], "id": "20336748-67e0-4f37-983f-52babc0fd284", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-20336748-67e0-4f37-983f-52babc0fd284" }, { "name": "Create an Insight Panel Interface", "id": "f06ec018-a8bb-4295-bb09-c95d7cfd8188", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "null", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces" ], "variable": [ { "id": "5d0c1a4e-9c55-4c87-9968-30650d73a01f", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Create an [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interface in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "c82b8104-3a75-434a-aefd-ebdcbb47d4a7", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "null", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces" ], "variable": [ { "key": "organizationId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "null", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-c82b8104-3a75-434a-aefd-ebdcbb47d4a7" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-f06ec018-a8bb-4295-bb09-c95d7cfd8188" }, { "name": "Get All Insight Panel Interfaces", "id": "e2c43d4e-b09c-4b5e-bdd0-5c7b03ba777f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces?filter=&page=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces" ], "query": [ { "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results.", "key": "filter", "value": "" }, { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.", "key": "perPage", "value": "" } ], "variable": [ { "id": "2b396a6b-ff1e-4ebc-af68-82aad66757b7", "key": "organizationId", "value": "", "description": "(Required) The unique identifier of the target [organization](https://docs.coveo.com/en/185/)." } ] }, "description": "Get all [Insight Panel](https://docs.coveo.com/en/m7ak9250/) interfaces in a [Coveo organization](https://docs.coveo.com/en/185/)." }, "response": [ { "id": "eb35b04a-b2d7-44fd-9a28-b47edc9c6975", "name": "Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/organizations/:organizationId/insightinterface/v1/interfaces?filter=&page=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "organizations", ":organizationId", "insightinterface", "v1", "interfaces" ], "query": [ { "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results.", "key": "filter", "value": "" }, { "description": "The 0-based number of the page of configurations to list.", "key": "page", "value": "" }, { "description": "The maximum number of configurations to include per page.", "key": "perPage", "value": "" } ], "variable": [ { "key": "organizationId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "null", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-eb35b04a-b2d7-44fd-9a28-b47edc9c6975" } ], "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-e2c43d4e-b09c-4b5e-bdd0-5c7b03ba777f" } ], "id": "58c52549-eb59-4419-98b0-930267d9a96a", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-58c52549-eb59-4419-98b0-930267d9a96a" } ], "id": "a1729174-ea5d-40cb-b994-549f62e1e49d", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-a1729174-ea5d-40cb-b994-549f62e1e49d" } ], "id": "7639bb8d-3a2f-46e0-8bf0-0181a39fd4d7", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-7639bb8d-3a2f-46e0-8bf0-0181a39fd4d7" } ], "id": "954ad9d8-baa4-4625-b3e4-15e11192de63", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-954ad9d8-baa4-4625-b3e4-15e11192de63" } ], "id": "b7fc3926-7016-4136-acc0-61620fe02335", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-b7fc3926-7016-4136-acc0-61620fe02335" } ], "id": "3cf688c0-cfdf-4350-8d1f-d49c7e85bd76", "createdAt": "2026-07-28T01:29:08.000Z", "updatedAt": "2026-07-28T01:29:08.000Z", "uid": "35240-3cf688c0-cfdf-4350-8d1f-d49c7e85bd76" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "full", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.cloud.coveo.com/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.cloud.coveo.com/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.cloud.coveo.com" } ] }