{ "info": { "_postman_id": "45605972-f3b9-42b8-8e93-0bfa8cfcdf71", "name": "Coveo Activity Activities Analysis V3 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:26:41.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "lastUpdatedBy": "35240", "uid": "35240-45605972-f3b9-42b8-8e93-0bfa8cfcdf71" }, "item": [ { "name": "rest", "item": [ { "name": "search", "item": [ { "name": "v3", "item": [ { "name": "analysis", "item": [ { "name": "expressions", "item": [ { "name": "structured", "item": [ { "name": "Convert Query to Structured Expression", "id": "ac953006-1f8e-4d6e-81b9-d963f619d2b3", "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": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/expressions/structured?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "expressions", "structured" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] }, "description": "Parses a query expression written using the Coveo query syntax, and converts it into a structured expression.\nto a structured expression.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXPRESSION_VALIDATION_RESULT\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "6bd130b9-7ef8-412b-8722-285e3c978eb4", "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": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/expressions/structured?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "expressions", "structured" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"structured\": {\n \"type\": \"and\",\n \"expressions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-6bd130b9-7ef8-412b-8722-285e3c978eb4" }, { "id": "7852d358-7b6e-4b4b-8442-c6810268e671", "name": "Bad Request", "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 \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/expressions/structured?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "expressions", "structured" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-7852d358-7b6e-4b4b-8442-c6810268e671" }, { "id": "c020744c-9013-4c80-a4f3-fc5f72b2950e", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "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 \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/expressions/structured?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "expressions", "structured" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-c020744c-9013-4c80-a4f3-fc5f72b2950e" }, { "id": "281fbe47-f56f-4460-bc84-29ca6d5c333a", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "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 \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/expressions/structured?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "expressions", "structured" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-281fbe47-f56f-4460-bc84-29ca6d5c333a" }, { "id": "6606c156-b2fc-4a3e-99cb-e917ca17dd27", "name": "Authentication Timeout", "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 \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/expressions/structured?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "expressions", "structured" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-6606c156-b2fc-4a3e-99cb-e917ca17dd27" }, { "id": "60f2fc1a-f97b-49b3-bdee-fc16f63d15a9", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"query\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/expressions/structured?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "expressions", "structured" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"status\": \"\",\n \"title\": \"\",\n \"type\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-60f2fc1a-f97b-49b3-bdee-fc16f63d15a9" } ], "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-ac953006-1f8e-4d6e-81b9-d963f619d2b3" } ], "id": "852689a6-c6db-4c22-ac36-d0ee904b807c", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-852689a6-c6db-4c22-ac36-d0ee904b807c" } ], "id": "41d7cdc4-de45-4b23-8c62-e76a869ee80a", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-41d7cdc4-de45-4b23-8c62-e76a869ee80a" }, { "name": "inspect", "item": [ { "name": "replay", "item": [ { "name": "Replay a Query with Inspection Details", "id": "3f16d98d-28d1-4338-b4b8-8f4052076f41", "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": "application/json" }, { "key": "Accept", "value": "application/application+json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] }, "description": "Replay a query that was already done and get inspection details.\n\n**Note:** This API call can only be used with an OAuth token. API Keys and Search Token aren't allowed.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"REPLAY_ANY_QUERY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "0b337746-4a5c-4d12-a7df-d84a85d7434b", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/application+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/application+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"requestParameters\": {\n \"dolor_6_4\": false,\n \"tempor_8c\": 38984840\n },\n \"execution\": [\n {\n \"durationInMs\": \"\",\n \"name\": \"Pipeline selection\",\n \"selectedPipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"condition\": {\n \"id\": \"\"\n }\n },\n \"selectionCause\": {\n \"type\": \"AUTHENTICATION_PIPELINE\",\n \"abTest\": {\n \"originalPipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"condition\": {\n \"id\": \"\"\n }\n },\n \"targetPipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"condition\": {\n \"id\": \"\"\n }\n }\n }\n },\n \"type\": \"pipelineSelection\"\n },\n {\n \"durationInMs\": \"\",\n \"name\": \"Pipeline selection\",\n \"selectedPipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"condition\": {\n \"id\": \"\"\n }\n },\n \"selectionCause\": {\n \"type\": \"AUTHENTICATION_PIPELINE\",\n \"abTest\": {\n \"originalPipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"condition\": {\n \"id\": \"\"\n }\n },\n \"targetPipeline\": {\n \"id\": \"\",\n \"name\": \"\",\n \"condition\": {\n \"id\": \"\"\n }\n }\n }\n },\n \"type\": \"pipelineSelection\"\n }\n ],\n \"results\": [\n {\n \"title\": \"\",\n \"clickUri\": \"\",\n \"fields\": {\n \"occaecat9f\": 25149808,\n \"mollit_8\": true,\n \"quisa77\": -13525181,\n \"officia_e8a\": 75519912\n },\n \"rankingInfo\": {\n \"documentWeights\": {\n \"dolor__73\": \"\"\n },\n \"totalWeight\": \"\",\n \"weightComposition\": {\n \"termsWeights\": [\n {\n \"term\": {\n \"et_8\": {\n \"reprehenderit__4\": \"\",\n \"est_c68\": \"\"\n },\n \"aliquipdb\": {\n \"aute_7\": \"\",\n \"eiusmod67_\": \"\"\n }\n },\n \"weightInfo\": {\n \"elitef\": \"\",\n \"Lorem4\": \"\",\n \"in_ebd\": \"\",\n \"in_c2\": \"\"\n }\n },\n {\n \"term\": {\n \"iddaf\": {\n \"reprehenderit3_8\": \"\"\n },\n \"ipsum95f\": {\n \"exercitation0\": \"\"\n },\n \"seda\": {\n \"occaecat_a\": \"\",\n \"utec1\": \"\",\n \"dolora8\": \"\",\n \"velit__f\": \"\"\n }\n },\n \"weightInfo\": {\n \"etc\": \"\",\n \"inf\": \"\"\n }\n }\n ],\n \"rankingFunctions\": [\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n }\n ],\n \"queryRankingExpressions\": [\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n }\n ]\n }\n }\n },\n {\n \"title\": \"\",\n \"clickUri\": \"\",\n \"fields\": {\n \"consecteture7\": false,\n \"ipsum_e5\": 58844385.76270673\n },\n \"rankingInfo\": {\n \"documentWeights\": {\n \"fugiat__2c\": \"\"\n },\n \"totalWeight\": \"\",\n \"weightComposition\": {\n \"termsWeights\": [\n {\n \"term\": {\n \"cillum_4b\": {\n \"adipisicing_d\": \"\"\n },\n \"et_3\": {\n \"sit_b8\": \"\",\n \"minim02\": \"\"\n },\n \"amet_abc\": {\n \"site2_\": \"\",\n \"consectetur_\": \"\"\n }\n },\n \"weightInfo\": {\n \"sit__09\": \"\",\n \"dolor_f8\": \"\",\n \"incididunt7\": \"\"\n }\n },\n {\n \"term\": {\n \"amet9\": {\n \"sed_d2\": \"\",\n \"iruree9\": \"\"\n }\n },\n \"weightInfo\": {\n \"sunt_a\": \"\"\n }\n }\n ],\n \"rankingFunctions\": [\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n }\n ],\n \"queryRankingExpressions\": [\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n },\n {\n \"expression\": \"\",\n \"origin\": \"\",\n \"score\": \"\",\n \"rule\": {\n \"type\": \"\",\n \"id\": \"\"\n }\n }\n ]\n }\n }\n }\n ],\n \"totalResultsCount\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-0b337746-4a5c-4d12-a7df-d84a85d7434b" }, { "id": "6e267b78-b0b9-46e9-910e-857e7583bbdb", "name": "Bad Request", "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 \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-6e267b78-b0b9-46e9-910e-857e7583bbdb" }, { "id": "d123ad19-d652-46f5-b90a-b10ef214c8bb", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "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 \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-d123ad19-d652-46f5-b90a-b10ef214c8bb" }, { "id": "1fafb8f3-fd15-4fd3-b660-afa2054b8c8f", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "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 \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-1fafb8f3-fd15-4fd3-b660-afa2054b8c8f" }, { "id": "25da02a4-bfee-4f78-89c5-00aac0d02340", "name": "Unable to find the request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-25da02a4-bfee-4f78-89c5-00aac0d02340" }, { "id": "cd678418-65f8-418a-a8ea-b0e2097847ff", "name": "Authentication Timeout", "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 \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-cd678418-65f8-418a-a8ea-b0e2097847ff" }, { "id": "48390be2-bbc4-4b82-ae5c-2a09c06f6054", "name": "Region is not currently supported by the service.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-48390be2-bbc4-4b82-ae5c-2a09c06f6054" }, { "id": "331755ef-4b77-4ab7-819a-dc9c5e69c497", "name": "Too Many Requests (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#429-too_many_requests)", "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 \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-331755ef-4b77-4ab7-819a-dc9c5e69c497" }, { "id": "269294b6-64da-4ac9-8517-c209a4c18e25", "name": "Search parameters too broad", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"dateRange\": {\n \"from\": \"\",\n \"to\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v3/analysis/inspect/replay?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v3", "analysis", "inspect", "replay" ], "query": [ { "description": "The unique identifier of the target Coveo Cloud organization.\n\nSpecifying a value for this parameter is only necessary when you are authenticating the API call with an OAuth2 token.", "key": "organizationId", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-269294b6-64da-4ac9-8517-c209a4c18e25" } ], "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-3f16d98d-28d1-4338-b4b8-8f4052076f41" } ], "id": "04f9aa80-cb86-4bf4-9d34-8b05c8413ed0", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-04f9aa80-cb86-4bf4-9d34-8b05c8413ed0" } ], "id": "b1ab3ecb-1565-4bab-b898-e35a4434a0f8", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-b1ab3ecb-1565-4bab-b898-e35a4434a0f8" } ], "id": "c08cedba-4fe6-4141-adf6-339283a952fd", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-c08cedba-4fe6-4141-adf6-339283a952fd" } ], "id": "2bc2cc34-35ed-4101-966d-bc8e0ba04aff", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-2bc2cc34-35ed-4101-966d-bc8e0ba04aff" } ], "id": "ed9d9c14-dd4b-48ad-ba85-8e15d6042d9e", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-ed9d9c14-dd4b-48ad-ba85-8e15d6042d9e" } ], "id": "2f265c32-e3b4-48c4-91d2-456b3298635b", "createdAt": "2026-07-28T01:26:42.000Z", "updatedAt": "2026-07-28T01:26:42.000Z", "uid": "35240-2f265c32-e3b4-48c4-91d2-456b3298635b" } ], "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" } ] }