{ "info": { "_postman_id": "ea378638-56aa-4c96-930f-1ad175a8794c", "name": "Coveo Activity Activities Statements V2 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:32:50.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "lastUpdatedBy": "35240", "uid": "35240-ea378638-56aa-4c96-930f-1ad175a8794c" }, "item": [ { "name": "rest", "item": [ { "name": "search", "item": [ { "name": "v2", "item": [ { "name": "admin", "item": [ { "name": "pipelines", "item": [ { "name": "{pipelineId}", "item": [ { "name": "statements", "item": [ { "name": "{statementId}", "item": [ { "name": "move", "item": [ { "name": "Move Query Pipeline Statement", "id": "74f6c313-aace-4920-b64d-febbf5ec4daa", "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": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"position\": \"\",\n \"after\": \"\",\n \"pageSize\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId/move?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId", "move" ], "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": "" } ], "variable": [ { "id": "77009093-e769-4a57-996d-098a473a2e08", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "f96e3dff-2ef3-4953-89f6-b1ed84a2d26b", "key": "statementId", "value": "", "description": "(Required) The unique identifier of the target statement." } ] }, "description": "Sets the position of a query pipeline statement in a specific query pipeline and updates other statement positions as appropriate.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "3f1def4a-5277-413f-9be7-f76ab3fc1157", "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 \"position\": \"\",\n \"after\": \"\",\n \"pageSize\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId/move?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId", "move" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n },\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"ranking\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n }\n]", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-3f1def4a-5277-413f-9be7-f76ab3fc1157" }, { "id": "35d7e838-b335-4b73-b129-a6fbff14ecb3", "name": "Bad Request", "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 \"position\": \"\",\n \"after\": \"\",\n \"pageSize\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId/move?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId", "move" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-35d7e838-b335-4b73-b129-a6fbff14ecb3" }, { "id": "e46272c9-3632-48a2-904f-6ec0d5ea9b70", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "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 \"position\": \"\",\n \"after\": \"\",\n \"pageSize\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId/move?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId", "move" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-e46272c9-3632-48a2-904f-6ec0d5ea9b70" }, { "id": "bd8e8582-fd9d-4e5c-a6d1-6301b8ef6c6d", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "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 \"position\": \"\",\n \"after\": \"\",\n \"pageSize\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId/move?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId", "move" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-bd8e8582-fd9d-4e5c-a6d1-6301b8ef6c6d" }, { "id": "b041a274-cdd8-4aee-88fa-5e7f0a019503", "name": "Authentication Timeout", "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 \"position\": \"\",\n \"after\": \"\",\n \"pageSize\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId/move?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId", "move" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-b041a274-cdd8-4aee-88fa-5e7f0a019503" }, { "id": "a6664e20-3b8f-4ed9-9039-8a1230409855", "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": "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 \"position\": \"\",\n \"after\": \"\",\n \"pageSize\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId/move?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId", "move" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-a6664e20-3b8f-4ed9-9039-8a1230409855" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-74f6c313-aace-4920-b64d-febbf5ec4daa" } ], "id": "bcbb0ad9-a1dd-45bb-8d31-d434feb95d96", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-bcbb0ad9-a1dd-45bb-8d31-d434feb95d96" }, { "name": "Get Query Pipeline Statement", "id": "67fb0505-c812-4ebf-b34f-b80205bd03d5", "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/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "id": "f8b14973-5969-4427-b347-5d3ac50d0eec", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "1213bb83-b2d7-43d1-bd8b-16e16f00e707", "key": "statementId", "value": "", "description": "(Required) The unique identifier of the target statement." } ] }, "description": "Gets a single query pipeline statement from a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "981858d5-4f8d-45a3-8ae4-47f4396c30fa", "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/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"topClicks\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-981858d5-4f8d-45a3-8ae4-47f4396c30fa" }, { "id": "8c47c2f8-8df2-4b19-9a25-2ac7a2067a1a", "name": "Bad Request", "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/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8c47c2f8-8df2-4b19-9a25-2ac7a2067a1a" }, { "id": "869102fd-5a42-4cd4-a4a5-afad2619902d", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "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/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-869102fd-5a42-4cd4-a4a5-afad2619902d" }, { "id": "1b6f1c44-df20-42b0-a332-2afd9ef1bdc6", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "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/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-1b6f1c44-df20-42b0-a332-2afd9ef1bdc6" }, { "id": "525cd145-6f0e-4f58-9b30-db0c27ba4a13", "name": "Authentication Timeout", "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/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-525cd145-6f0e-4f58-9b30-db0c27ba4a13" }, { "id": "6482c033-dba4-409c-aac9-923be987a9c0", "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": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-6482c033-dba4-409c-aac9-923be987a9c0" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-67fb0505-c812-4ebf-b34f-b80205bd03d5" }, { "name": "Update Query Pipeline Statement", "id": "a5ec6750-266d-47a8-88d2-d79434e2a496", "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": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "id": "372cbd7b-fa2c-431e-b1a8-0e3109fa93a2", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "4e6679c7-ef11-4d72-b001-33b6d53903f2", "key": "statementId", "value": "", "description": "(Required) The unique identifier of the target statement." } ] }, "description": "Updates a single query pipeline statement in a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "fb52b2e3-bddb-4930-a90c-c6ec175a41bd", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"topClicks\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-fb52b2e3-bddb-4930-a90c-c6ec175a41bd" }, { "id": "69c5689d-fe11-42a7-bee1-d9eae6a8f01b", "name": "Bad Request", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-69c5689d-fe11-42a7-bee1-d9eae6a8f01b" }, { "id": "28908b18-b7dd-42fe-abd8-5f5b59c13a4f", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-28908b18-b7dd-42fe-abd8-5f5b59c13a4f" }, { "id": "5150f2ee-9a13-4fef-a3de-bf08b28ac02e", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-5150f2ee-9a13-4fef-a3de-bf08b28ac02e" }, { "id": "e93460c4-bd80-4669-aa5f-1e3961255edd", "name": "Authentication Timeout", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-e93460c4-bd80-4669-aa5f-1e3961255edd" }, { "id": "1daecbc4-f76d-4b60-9d81-58c8c6085bc6", "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": "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-1daecbc4-f76d-4b60-9d81-58c8c6085bc6" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-a5ec6750-266d-47a8-88d2-d79434e2a496" }, { "name": "Delete Query Pipeline Statement", "id": "6a93ed31-0a31-465f-9de5-a5a7a77c6633", "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": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "id": "edaf873c-a232-4920-a51b-383f296bfcbb", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "eb8801eb-57dc-446d-a81b-f03b69d80f24", "key": "statementId", "value": "", "description": "(Required) The unique identifier of the target statement." } ] }, "description": "Deletes a single query pipeline statement from a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "1c38765a-8187-423f-98b6-52eadfc75a9c", "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-1c38765a-8187-423f-98b6-52eadfc75a9c" }, { "id": "f21a6a85-dfb3-4d70-bcaa-8d709a1e14dd", "name": "No content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-f21a6a85-dfb3-4d70-bcaa-8d709a1e14dd" }, { "id": "387ad6e1-1b61-4b17-984f-c7fa46d93373", "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-387ad6e1-1b61-4b17-984f-c7fa46d93373" }, { "id": "45e6f801-4164-47e6-af10-227d15dca9c5", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-45e6f801-4164-47e6-af10-227d15dca9c5" }, { "id": "38e2b7e8-2fde-44d8-9517-8baa24714572", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-38e2b7e8-2fde-44d8-9517-8baa24714572" }, { "id": "ec87f038-90c2-428a-840b-ed988b91c1ef", "name": "Authentication Timeout", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-ec87f038-90c2-428a-840b-ed988b91c1ef" }, { "id": "8079d773-6a98-4663-8a12-2ab49360545d", "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": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/:statementId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", ":statementId" ], "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": "" } ], "variable": [ { "key": "pipelineId" }, { "key": "statementId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8079d773-6a98-4663-8a12-2ab49360545d" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-6a93ed31-0a31-465f-9de5-a5a7a77c6633" } ], "id": "9fec75fc-a7f8-4f6d-949e-d23ee9f53a27", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-9fec75fc-a7f8-4f6d-949e-d23ee9f53a27" }, { "name": "bulkGet", "item": [ { "name": "List Query Pipeline Statements", "id": "cb3cfd99-cca8-4191-8f70-7673cbc67519", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "id": "ca3789a3-ece0-4c40-a7c9-45d250e8b41d", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "7d13051b-f47d-4f21-8017-dafdaa4daf6c", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statements\": [\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n },\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"recommendation\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-7d13051b-f47d-4f21-8017-dafdaa4daf6c" }, { "id": "e5c3ce41-346d-498f-9fd7-dc58eab22776", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-e5c3ce41-346d-498f-9fd7-dc58eab22776" }, { "id": "c7df3e6b-eb98-44e3-93be-d0a34706353b", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-c7df3e6b-eb98-44e3-93be-d0a34706353b" }, { "id": "11d1c75d-30a8-41f0-a9ee-c6d536152fed", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-11d1c75d-30a8-41f0-a9ee-c6d536152fed" }, { "id": "87446455-27cd-4785-b7d7-41c324299e2e", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-87446455-27cd-4785-b7d7-41c324299e2e" }, { "id": "49e1e8c6-269f-4ce2-8085-12ab97503b09", "name": "Unprocessable Entity", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-49e1e8c6-269f-4ce2-8085-12ab97503b09" }, { "id": "bef23d96-8265-458c-9ee1-5195482883ff", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkGet?organizationId=&isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkGet" ], "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": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-bef23d96-8265-458c-9ee1-5195482883ff" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-cb3cfd99-cca8-4191-8f70-7673cbc67519" } ], "id": "64cecd15-48d6-4e0d-86e0-f217cc8cf938", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-64cecd15-48d6-4e0d-86e0-f217cc8cf938" }, { "name": "bulkDelete", "item": [ { "name": "Bulk Delete Query Pipeline Statements", "id": "ec2858b7-a3f3-4858-bfe4-11597b75640b", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkDelete" ], "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": "" } ], "variable": [ { "id": "f103e3c9-3b39-4d96-b925-d580e5dc7e36", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Delete multiple statements at once for a specific pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "21e227df-fc13-47ca-ae4f-386979303d1b", "name": "Deleted", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkDelete" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-21e227df-fc13-47ca-ae4f-386979303d1b" }, { "id": "afa194ae-17d8-4604-ab28-a3110f53720e", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkDelete" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-afa194ae-17d8-4604-ab28-a3110f53720e" }, { "id": "b3c313c6-8983-4f06-94f0-ab6fdeb11a3a", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkDelete" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-b3c313c6-8983-4f06-94f0-ab6fdeb11a3a" }, { "id": "de927d4e-bb64-405a-abe8-c372a751bc9d", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkDelete" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-de927d4e-bb64-405a-abe8-c372a751bc9d" }, { "id": "2268e2cb-0d0e-4dbf-b6d0-8f76867c00ce", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkDelete" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-2268e2cb-0d0e-4dbf-b6d0-8f76867c00ce" }, { "id": "b21c13e7-58d5-4bf9-a1be-59645864a158", "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 \"ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "bulkDelete" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-b21c13e7-58d5-4bf9-a1be-59645864a158" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-ec2858b7-a3f3-4858-bfe4-11597b75640b" } ], "id": "45e22f11-21a2-42ed-9e7f-2bc0356e1e29", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-45e22f11-21a2-42ed-9e7f-2bc0356e1e29" }, { "name": "copy", "item": [ { "name": "Copy Query Pipeline Statements", "id": "1980fa52-d2a1-4fbf-8c78-2632f0275032", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "id": "808d3c95-3a6b-42fc-a93f-a8846860d243", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Copies specific statements from an origin to a target query pipeline. Using the same pipeline as origin and target will duplicate the specified statements in that pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "d59cd5a5-3f7d-481b-8751-a2d39365c133", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statements\": [\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n },\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"recommendation\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-d59cd5a5-3f7d-481b-8751-a2d39365c133" }, { "id": "f4c61566-15ca-4b8e-8644-1e25e2c02e8b", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"topClicks\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-f4c61566-15ca-4b8e-8644-1e25e2c02e8b" }, { "id": "3fa8d5ab-4a7a-476f-b128-4d1627885172", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-3fa8d5ab-4a7a-476f-b128-4d1627885172" }, { "id": "8c9d03af-2bef-40f2-bc47-341a61ab6255", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8c9d03af-2bef-40f2-bc47-341a61ab6255" }, { "id": "295b8c2f-4f63-4211-904b-63c4a460eacb", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-295b8c2f-4f63-4211-904b-63c4a460eacb" }, { "id": "c0258ee0-d840-4dfb-b75d-96cf64a7eb88", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-c0258ee0-d840-4dfb-b75d-96cf64a7eb88" }, { "id": "8beaea00-6c76-4b2a-ab45-c6f97d9996fd", "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 \"destinationPipelineId\": \"\",\n \"statementIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "copy" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8beaea00-6c76-4b2a-ab45-c6f97d9996fd" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-1980fa52-d2a1-4fbf-8c78-2632f0275032" } ], "id": "7000359b-3abe-4ac5-b499-049df6c87527", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-7000359b-3abe-4ac5-b499-049df6c87527" }, { "name": "export", "item": [ { "name": "Export Query Pipeline Statements", "id": "7a55dc24-9493-4506-a978-61f72ae8a1a0", "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": "text/csv" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/export?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "export" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "id": "590e04a4-2a30-42b7-bbb9-7b6a5f453324", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Exports the definition, condition, and description of statements from a specific query pipeline to a CSV file.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "8fc01a24-11a0-41f7-8767-a58cec7f2727", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "text/csv" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/export?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "export" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/csv" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8fc01a24-11a0-41f7-8767-a58cec7f2727" }, { "id": "f318ade4-da64-4bd6-9aa8-8cba1eaf704f", "name": "Bad Request", "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/search/v2/admin/pipelines/:pipelineId/statements/export?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "export" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-f318ade4-da64-4bd6-9aa8-8cba1eaf704f" }, { "id": "bb3942af-81be-4292-b514-01cdc9ac49bf", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "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/search/v2/admin/pipelines/:pipelineId/statements/export?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "export" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-bb3942af-81be-4292-b514-01cdc9ac49bf" }, { "id": "8562ae0b-2d32-4fe2-971c-5b1be565810d", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "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/search/v2/admin/pipelines/:pipelineId/statements/export?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "export" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8562ae0b-2d32-4fe2-971c-5b1be565810d" }, { "id": "509732b3-b0fc-46d5-98be-ff04bcb81905", "name": "Authentication Timeout", "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/search/v2/admin/pipelines/:pipelineId/statements/export?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "export" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-509732b3-b0fc-46d5-98be-ff04bcb81905" }, { "id": "7310e016-b4cf-421c-a506-6612942f0c76", "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": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/export?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "export" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-7310e016-b4cf-421c-a506-6612942f0c76" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-7a55dc24-9493-4506-a978-61f72ae8a1a0" } ], "id": "20dba27f-fae3-42d5-b96c-c4f2e30487fd", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-20dba27f-fae3-42d5-b96c-c4f2e30487fd" }, { "name": "import", "item": [ { "name": "Import Query Pipeline Statements", "id": "a6f03e7e-02b0-4014-844d-316a137d74bb", "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": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "id": "e5f7979e-e746-4732-ab76-0b737baac7d3", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Import the definition, condition, and description of statements from a CSV file to a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "9664fdf6-fa5b-46fe-a12e-03accbcdd79c", "name": "Imported", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-9664fdf6-fa5b-46fe-a12e-03accbcdd79c" }, { "id": "b38a8f9b-f8ce-4274-815a-8a915c2c0b18", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-b38a8f9b-f8ce-4274-815a-8a915c2c0b18" }, { "id": "6bdefdb6-ca8b-4976-8209-adff04ede519", "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": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-6bdefdb6-ca8b-4976-8209-adff04ede519" }, { "id": "61d9c97d-f0e0-49c1-bbd8-36f410fcf5c5", "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": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-61d9c97d-f0e0-49c1-bbd8-36f410fcf5c5" }, { "id": "fab06aa4-fb55-4cb1-b8b5-4311a26ff3a0", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-fab06aa4-fb55-4cb1-b8b5-4311a26ff3a0" }, { "id": "8e28c04e-8b8e-4790-8d9a-8315b9c0b3bb", "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": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "fileName", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/import?feature=&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "import" ], "query": [ { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8e28c04e-8b8e-4790-8d9a-8315b9c0b3bb" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-a6f03e7e-02b0-4014-844d-316a137d74bb" } ], "id": "f241e56a-2680-4438-bb0b-e55074ce376e", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-f241e56a-2680-4438-bb0b-e55074ce376e" }, { "name": "validate", "item": [ { "name": "batch", "item": [ { "name": "Validate a Batch of Statement Operations.", "id": "41e322d9-4d91-4b07-b107-41e4378d007d", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "id": "87c76367-f6c4-42e5-9eaf-8e8732a51f3d", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "\r\n Validate that a list of operations would be accepted by our API and executed.\r\n A maximum of 15 can be processed per request.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "d241aafa-66ef-4ccc-a39f-7eae9bcc97cb", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"results\": [\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"nostrud_f\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"minim3\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"Lorem771\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-d241aafa-66ef-4ccc-a39f-7eae9bcc97cb" }, { "id": "783855d0-13e1-4605-b16f-a5a3cd6859ec", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-783855d0-13e1-4605-b16f-a5a3cd6859ec" }, { "id": "d32bbe86-377c-41d5-943c-43d5d66c333d", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-d32bbe86-377c-41d5-943c-43d5d66c333d" }, { "id": "b2887f7e-01b9-4533-a96f-4a372188973f", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-b2887f7e-01b9-4533-a96f-4a372188973f" }, { "id": "025176e9-ea30-45f8-845a-fbd6f09cbe0c", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-025176e9-ea30-45f8-845a-fbd6f09cbe0c" }, { "id": "93d5129d-ecb9-4b00-be2c-8c3416753ec9", "name": "Unprocessable Entity", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-93d5129d-ecb9-4b00-be2c-8c3416753ec9" }, { "id": "018cd8fd-cc09-4726-9a26-8a85af1c2a35", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-018cd8fd-cc09-4726-9a26-8a85af1c2a35" }, { "id": "c3edb4db-e087-492f-ba1f-f00b8ee9b14e", "name": "Service Unavailable (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#5xx)", "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 \"operations\": [\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n },\n {\n \"operationType\": \"DELETE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate", "batch" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Service Unavailable", "code": 503, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-c3edb4db-e087-492f-ba1f-f00b8ee9b14e" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-41e322d9-4d91-4b07-b107-41e4378d007d" } ], "id": "c5d5289e-1d28-4fa8-8860-98d18e314a1c", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-c5d5289e-1d28-4fa8-8860-98d18e314a1c" }, { "name": "Validate a Single Statement Operation.", "id": "3c5e7633-11e3-4bec-a640-f86fa30d40d9", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "id": "52d850e1-ca9f-42e6-9884-744266760ba4", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Validate that a specific operation would be accepted by our API and executed.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "f1cda36d-e1c9-4de8-a717-9c8e3e122fc2", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"officiacdc\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"eiusmod18\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-f1cda36d-e1c9-4de8-a717-9c8e3e122fc2" }, { "id": "5e5c86a2-be1f-4587-a5a2-2b7b55245463", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-5e5c86a2-be1f-4587-a5a2-2b7b55245463" }, { "id": "6d13d009-19d6-4512-bcb0-b87df1319b29", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-6d13d009-19d6-4512-bcb0-b87df1319b29" }, { "id": "df3a1f52-8014-4a6d-bc5a-89878b1bea6b", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-df3a1f52-8014-4a6d-bc5a-89878b1bea6b" }, { "id": "1fcd603e-8e74-486c-a00f-f88e491f6751", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-1fcd603e-8e74-486c-a00f-f88e491f6751" }, { "id": "09cfee83-a72f-431d-ae8b-d82ea6a4fa4d", "name": "Unprocessable Entity", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-09cfee83-a72f-431d-ae8b-d82ea6a4fa4d" }, { "id": "ac356c90-8fe9-440c-96c6-1ba7e149520c", "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 \"operation\": {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"definition\": \"\",\n \"feature\": \"queryParamOverride\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n },\n \"resourceId\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements", "validate" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-ac356c90-8fe9-440c-96c6-1ba7e149520c" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-3c5e7633-11e3-4bec-a640-f86fa30d40d9" } ], "id": "e1b8aec4-a8c6-48ef-902e-ef44e066e2bd", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-e1b8aec4-a8c6-48ef-902e-ef44e066e2bd" }, { "name": "List Query Pipeline Statements", "id": "5eb49843-8459-476b-9f7b-e668c00a7e35", "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/search/v2/admin/pipelines/:pipelineId/statements?isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=&subFeature=querySuggestParamOverride&subFeature=queryParamOverride&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "querySuggestParamOverride" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "queryParamOverride" }, { "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": "" } ], "variable": [ { "id": "4c5e2d00-81f4-4b4f-91d6-4b156dbfdc32", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, "response": [ { "id": "5cbce118-091d-4b1b-906f-dbccecea236a", "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/search/v2/admin/pipelines/:pipelineId/statements?isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=&subFeature=queryParamOverride&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "queryParamOverride" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statements\": [\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"thesaurus\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n },\n {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"recommendation\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n }\n ],\n \"totalCount\": \"\",\n \"totalEntries\": \"\",\n \"totalPages\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-5cbce118-091d-4b1b-906f-dbccecea236a" }, { "id": "ed99740d-2757-4b5d-a597-6ba727dc4b47", "name": "Bad Request", "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/search/v2/admin/pipelines/:pipelineId/statements?isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=&subFeature=queryParamOverride&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "queryParamOverride" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-ed99740d-2757-4b5d-a597-6ba727dc4b47" }, { "id": "76c9f145-082b-4fda-a222-515a3e9d703b", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "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/search/v2/admin/pipelines/:pipelineId/statements?isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=&subFeature=queryParamOverride&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "queryParamOverride" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-76c9f145-082b-4fda-a222-515a3e9d703b" }, { "id": "1b32d7d5-ea81-4d0b-921b-9b05bd79049f", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "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/search/v2/admin/pipelines/:pipelineId/statements?isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=&subFeature=queryParamOverride&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "queryParamOverride" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-1b32d7d5-ea81-4d0b-921b-9b05bd79049f" }, { "id": "818aed4b-1210-4c14-b602-9be127f167f0", "name": "Authentication Timeout", "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/search/v2/admin/pipelines/:pipelineId/statements?isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=&subFeature=queryParamOverride&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "queryParamOverride" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-818aed4b-1210-4c14-b602-9be127f167f0" }, { "id": "d8862f3a-b1d1-4dc2-bae5-5305b88ee986", "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": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?isOrderAscending=true&filter=&sortBy=&page=0&perPage=20&feature=&subFeature=queryParamOverride&organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "query": [ { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The query filter to match.\n\nThis allows you to search within query pipeline statement definitions and descriptions.\n\nBy default, results are not required to match a specific query filter.", "key": "filter", "value": "" }, { "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`", "key": "sortBy", "value": "" }, { "description": "The 0-based number of the page of results to get.", "key": "page", "value": "0" }, { "description": "The number of results to include per page.", "key": "perPage", "value": "20" }, { "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature.", "key": "feature", "value": "" }, { "description": "The query pipeline sub-feature to match.\n\n**Allowed values:**\n\n- Parameter overrides: `queryParamOverride` and `querySuggestParamOverride`.\n\nBy default, results are not required to match a specific query pipeline sub-feature.", "key": "subFeature", "value": "queryParamOverride" }, { "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-d8862f3a-b1d1-4dc2-bae5-5305b88ee986" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-5eb49843-8459-476b-9f7b-e668c00a7e35" }, { "name": "Create Query Pipeline Statement", "id": "9c32a1ea-c328-4460-85dc-b0fcba579bc8", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "id": "19ebec79-3d4d-4aa4-9a9a-913893a3d8de", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Creates a new query pipeline statement in a specific query pipeline.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "4be68f6b-ebbd-4e15-840b-cbfd6065d0d8", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"topClicks\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-4be68f6b-ebbd-4e15-840b-cbfd6065d0d8" }, { "id": "b8bd1cd9-b57d-48bc-b929-034440570c61", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {},\n \"feature\": \"topClicks\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"parent\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"condition\": {\n \"childrenCount\": \"\",\n \"definition\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n },\n \"feature\": \"when\",\n \"id\": \"\",\n \"position\": \"\",\n \"ready\": \"\",\n \"description\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"parent\": \"\",\n \"condition\": \"\"\n },\n \"warnings\": [\n \"\",\n \"\"\n ],\n \"displayName\": \"\",\n \"modifiedBy\": \"\",\n \"modifiedAt\": \"\",\n \"statementGroupId\": \"\"\n}", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-b8bd1cd9-b57d-48bc-b929-034440570c61" }, { "id": "fdda064a-32d5-4d48-ac07-636ea6cf61fd", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-fdda064a-32d5-4d48-ac07-636ea6cf61fd" }, { "id": "9f39ccc9-8676-4048-a5f5-ce0f049452d8", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-9f39ccc9-8676-4048-a5f5-ce0f049452d8" }, { "id": "e4ff3619-16fe-411d-9664-9f8aa8d1f48f", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-e4ff3619-16fe-411d-9664-9f8aa8d1f48f" }, { "id": "5ea5c104-56a2-47f2-a684-8c67fd16375a", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "_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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-5ea5c104-56a2-47f2-a684-8c67fd16375a" }, { "id": "37883c17-e133-46a5-aaa4-af6e7512f43e", "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 \"definition\": \"\",\n \"feature\": \"filter\",\n \"id\": \"\",\n \"description\": \"\",\n \"parent\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/statements?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "statements" ], "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": "" } ], "variable": [ { "key": "pipelineId" } ] } }, "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:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-37883c17-e133-46a5-aaa4-af6e7512f43e" } ], "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-9c32a1ea-c328-4460-85dc-b0fcba579bc8" } ], "id": "8e07e5ba-11e1-48af-9cb7-914d742394ce", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-8e07e5ba-11e1-48af-9cb7-914d742394ce" } ], "id": "eecb7f1f-50bf-4259-a28f-7a45a97c8c0e", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-eecb7f1f-50bf-4259-a28f-7a45a97c8c0e" } ], "id": "55cc6204-b2a0-439a-89a5-d74014afe5d5", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-55cc6204-b2a0-439a-89a5-d74014afe5d5" } ], "id": "0fe679b0-2a16-478a-a06f-99174ad352ce", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-0fe679b0-2a16-478a-a06f-99174ad352ce" } ], "id": "228cab7b-3be7-404c-abe3-b5042e709cfe", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-228cab7b-3be7-404c-abe3-b5042e709cfe" } ], "id": "e67d3af7-01cd-497b-a086-c2c6d829446a", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-e67d3af7-01cd-497b-a086-c2c6d829446a" } ], "id": "4021d816-8461-4897-8800-b98b95fc5163", "createdAt": "2026-07-28T01:32:51.000Z", "updatedAt": "2026-07-28T01:32:51.000Z", "uid": "35240-4021d816-8461-4897-8800-b98b95fc5163" } ], "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" } ] }