{ "info": { "_postman_id": "d38e29ee-698d-43c5-b0f3-06eabec31b2f", "name": "Coveo Activity Activities Result rankings 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:31:26.000Z", "updatedAt": "2026-07-28T01:31:26.000Z", "lastUpdatedBy": "35240", "uid": "35240-d38e29ee-698d-43c5-b0f3-06eabec31b2f" }, "item": [ { "name": "rest", "item": [ { "name": "search", "item": [ { "name": "v2", "item": [ { "name": "admin", "item": [ { "name": "pipelines", "item": [ { "name": "{pipelineId}", "item": [ { "name": "resultRankings", "item": [ { "name": "{resultRankingId}", "item": [ { "name": "Get a Result Ranking Rule", "id": "dfc7f0bb-d850-4616-898e-10f7c9e6c47d", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "2dbc19a5-e844-4472-9e4f-6b2fc013ad19", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "42e5faaa-0227-4d13-a549-8921124c00b8", "key": "resultRankingId", "value": "", "description": "(Required) The unique identifier of the result ranking." } ] }, "description": "Get a result ranking rule\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "b6e508b5-5e61-4615-9cf4-bef3426438b1", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"unspecified\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"associatedGroup\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"notStarted\"\n },\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-b6e508b5-5e61-4615-9cf4-bef3426438b1" }, { "id": "f5db55fd-026a-4ed7-911f-68999aaaa1bd", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-f5db55fd-026a-4ed7-911f-68999aaaa1bd" }, { "id": "4146570a-99d2-4977-8148-a9e75766836b", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-4146570a-99d2-4977-8148-a9e75766836b" }, { "id": "75419720-d126-4842-b559-1dce2787ec14", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-75419720-d126-4842-b559-1dce2787ec14" }, { "id": "e9e87bbb-e53e-4d4d-a653-e6d8f60e5ae4", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-e9e87bbb-e53e-4d4d-a653-e6d8f60e5ae4" }, { "id": "d0387527-9121-487f-9932-859a4dd83f05", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-d0387527-9121-487f-9932-859a4dd83f05" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-dfc7f0bb-d850-4616-898e-10f7c9e6c47d" }, { "name": "Update a Result Ranking Rule", "id": "76af9acf-fefb-4e28-8989-47e18a617ad5", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "27f635eb-42fb-43cd-8d2c-f9c4bfffff54", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "20ebe605-aeea-458d-8ced-84d7a032b03f", "key": "resultRankingId", "value": "", "description": "(Required) The unique identifier of the result ranking." } ] }, "description": "Update a result ranking rule\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "93ad0150-0329-4e98-a74b-6c5efcf10891", "name": "No Content", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-93ad0150-0329-4e98-a74b-6c5efcf10891" }, { "id": "c477ab78-2709-44d9-b0c6-d6bdbaedd75a", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-c477ab78-2709-44d9-b0c6-d6bdbaedd75a" }, { "id": "af650c8a-08a3-470d-aae0-627eeaf3a8e6", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-af650c8a-08a3-470d-aae0-627eeaf3a8e6" }, { "id": "b69744a0-ded3-4aba-b70e-e56cb2b76ffd", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-b69744a0-ded3-4aba-b70e-e56cb2b76ffd" }, { "id": "ab83f4e1-8701-47a2-a422-6bdcb8147251", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-ab83f4e1-8701-47a2-a422-6bdcb8147251" }, { "id": "edf12166-fb24-4e1b-a464-e0906e962a58", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-edf12166-fb24-4e1b-a464-e0906e962a58" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-76af9acf-fefb-4e28-8989-47e18a617ad5" }, { "name": "Delete a Result Ranking Rule", "id": "39fbedaa-3f28-4f71-8dad-c5e1ec814ff7", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "2149709b-a8a9-4b25-ac57-635683fcba4b", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "065bba02-6531-4478-82c9-572eb12d7a29", "key": "resultRankingId", "value": "", "description": "(Required) The unique identifier of the result ranking." } ] }, "description": "Deletes a result ranking rule\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "14a16851-8a42-441e-b45f-05130d507627", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-14a16851-8a42-441e-b45f-05130d507627" }, { "id": "523a0329-cd23-4743-b78d-d2d09c5043c7", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-523a0329-cd23-4743-b78d-d2d09c5043c7" }, { "id": "e80159c5-25f9-43b2-802c-17f48b2d1d50", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-e80159c5-25f9-43b2-802c-17f48b2d1d50" }, { "id": "36e574c1-a197-4370-8501-852ef27a5e52", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-36e574c1-a197-4370-8501-852ef27a5e52" }, { "id": "70c34624-1bd9-443c-91a7-6aea610c2555", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-70c34624-1bd9-443c-91a7-6aea610c2555" }, { "id": "907697b0-ae39-469c-8ac5-9f3a62493329", "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/resultRankings/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-907697b0-ae39-469c-8ac5-9f3a62493329" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-39fbedaa-3f28-4f71-8dad-c5e1ec814ff7" } ], "id": "b88c2cf1-4918-4101-a3ef-50db1dca5b5f", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-b88c2cf1-4918-4101-a3ef-50db1dca5b5f" }, { "name": "bulkGet", "item": [ { "name": "Bulk Get Result Ranking Rules", "id": "3c495f39-9452-43f4-b31a-2bf54b768a3a", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "variable": [ { "id": "cd72f141-9f78-4499-8e0e-32b78fb418ee", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Bulk get result ranking rules\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "c2f2d876-751f-4204-86a2-bbda89245d0e", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resultRankings\": [\n {\n \"id\": \"\",\n \"resultRanking\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"unspecified\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n },\n \"associatedGroup\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"expired\"\n }\n },\n {\n \"id\": \"\",\n \"resultRanking\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n },\n \"associatedGroup\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"inactive\"\n }\n }\n ],\n \"totalCount\": \"\",\n \"totalPages\": \"\",\n \"groupedBy\": {\n \"groups\": {\n \"associated\": {\n \"etf\": \"\",\n \"dolore_d\": \"\"\n },\n \"orphaned\": \"\"\n },\n \"status\": {\n \"active\": \"\",\n \"inactive\": \"\"\n },\n \"type\": {\n \"featuredResults\": \"\",\n \"rankingExpressions\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-c2f2d876-751f-4204-86a2-bbda89245d0e" }, { "id": "eafe310c-b539-4630-a7b5-6ba14dfb746e", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-eafe310c-b539-4630-a7b5-6ba14dfb746e" }, { "id": "71c524ad-51c5-4513-8c30-bf7fff4247af", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-71c524ad-51c5-4513-8c30-bf7fff4247af" }, { "id": "af2b09a3-b205-4d45-a2e4-cfbd5d2794ef", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-af2b09a3-b205-4d45-a2e4-cfbd5d2794ef" }, { "id": "9e293b13-ee39-44c4-93ba-d8018875e46e", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-9e293b13-ee39-44c4-93ba-d8018875e46e" }, { "id": "25d69093-04c6-4065-8c07-97388932a8f4", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-25d69093-04c6-4065-8c07-97388932a8f4" }, { "id": "4739b911-41c1-4bc5-bd69-5214585a27ad", "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/resultRankings/bulkGet?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&filter=&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "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 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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-4739b911-41c1-4bc5-bd69-5214585a27ad" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-3c495f39-9452-43f4-b31a-2bf54b768a3a" } ], "id": "3fbb72b4-2dce-4936-b906-47963c321955", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-3fbb72b4-2dce-4936-b906-47963c321955" }, { "name": "bulkDelete", "item": [ { "name": "Bulk Delete Result Rankings Rules from a Pipeline", "id": "7036d816-5d55-4e64-9f99-eba6c8afe3c9", "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/resultRankings/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "fd2bca13-3931-4dff-8041-97181d8c88fc", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Delete multiple result rankings rules in batch 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": "5043198f-f3b9-410a-bbfa-325ac92bafa3", "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/resultRankings/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-5043198f-f3b9-410a-bbfa-325ac92bafa3" }, { "id": "ae9feb5d-6441-47e1-a1ed-db921f39e644", "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/resultRankings/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-ae9feb5d-6441-47e1-a1ed-db921f39e644" }, { "id": "2df11e46-3a13-4d0f-a3aa-e078ba673f76", "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/resultRankings/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-2df11e46-3a13-4d0f-a3aa-e078ba673f76" }, { "id": "260e6dfd-ab1f-4290-9d2d-cefc0b3ca009", "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/resultRankings/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-260e6dfd-ab1f-4290-9d2d-cefc0b3ca009" }, { "id": "11be09b8-f731-4b20-9467-615cafb593e3", "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/resultRankings/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-11be09b8-f731-4b20-9467-615cafb593e3" }, { "id": "0872f860-812e-4d75-8d7d-305c42203fe7", "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/resultRankings/bulkDelete?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-0872f860-812e-4d75-8d7d-305c42203fe7" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-7036d816-5d55-4e64-9f99-eba6c8afe3c9" } ], "id": "b6034682-09ec-43c8-9b1f-0f761dae199f", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-b6034682-09ec-43c8-9b1f-0f761dae199f" }, { "name": "copy", "item": [ { "name": "Copy Result Rankings Rules to a Pipeline.", "id": "ea1426aa-d2a3-4d3d-a224-2974088a82b0", "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 \"resultRankingIds\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "985698d1-7b0e-4ba5-8904-6c44e3166dc1", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Copies specific result ranking rules 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": "aaf935e1-442e-460a-9e1d-47a8bcacb133", "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 \"resultRankingIds\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"resultRankings\": [\n {\n \"id\": \"\",\n \"resultRanking\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"unspecified\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"id\": \"\",\n \"resultRanking\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-aaf935e1-442e-460a-9e1d-47a8bcacb133" }, { "id": "f6f95975-8f90-4bdb-90d5-0b24a478eb23", "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 \"resultRankingIds\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-f6f95975-8f90-4bdb-90d5-0b24a478eb23" }, { "id": "d5f67494-ccaf-45be-b444-477bd90f2825", "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 \"resultRankingIds\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-d5f67494-ccaf-45be-b444-477bd90f2825" }, { "id": "9baedbb4-8bb2-4dbe-9214-cb6eb3946bba", "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 \"resultRankingIds\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-9baedbb4-8bb2-4dbe-9214-cb6eb3946bba" }, { "id": "f789a89c-7fbb-46fd-9744-49578007aa7d", "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 \"resultRankingIds\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-f789a89c-7fbb-46fd-9744-49578007aa7d" }, { "id": "b45bb226-c4d7-428e-adf3-cb5f399eb3d7", "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 \"resultRankingIds\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-b45bb226-c4d7-428e-adf3-cb5f399eb3d7" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-ea1426aa-d2a3-4d3d-a224-2974088a82b0" } ], "id": "8d4a3f53-8914-47ac-a338-dcb39df0bfaa", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-8d4a3f53-8914-47ac-a338-dcb39df0bfaa" }, { "name": "duplicate", "item": [ { "name": "{resultRankingId}", "item": [ { "name": "Duplicate a Result Ranking Rule", "id": "1cf4890a-bbd1-48b6-bcd8-45048764e7df", "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": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/duplicate/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "duplicate", ":resultRankingId" ], "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": "ca3ce011-a310-433f-b561-90cad070161b", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." }, { "id": "4dad0db0-0b58-4b88-a73a-de7d5e9503ad", "key": "resultRankingId", "value": "", "description": "(Required) The unique identifier of the result ranking." } ] }, "description": "Duplicate a result ranking rule\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": "a4f3121c-485c-4b9a-9a83-b30957a478d1", "name": "OK", "originalRequest": { "method": "POST", "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/resultRankings/duplicate/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "duplicate", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"resultRanking\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n },\n \"associatedGroup\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"inactive\"\n }\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-a4f3121c-485c-4b9a-9a83-b30957a478d1" }, { "id": "8994e799-4842-46be-a8d2-f1c16f7a0170", "name": "Bad Request", "originalRequest": { "method": "POST", "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/resultRankings/duplicate/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "duplicate", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-8994e799-4842-46be-a8d2-f1c16f7a0170" }, { "id": "94b346aa-d940-48d1-a571-46f094034dc9", "name": "Unauthorized (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#401-unauthorized)", "originalRequest": { "method": "POST", "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/resultRankings/duplicate/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "duplicate", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-94b346aa-d940-48d1-a571-46f094034dc9" }, { "id": "345e0937-1892-4cf5-b96b-ee5c5b2aa8e8", "name": "Forbidden (see: https://docs.coveo.com/en/1471/build-a-search-ui/troubleshoot-query-error-codes#403-forbidden)", "originalRequest": { "method": "POST", "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/resultRankings/duplicate/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "duplicate", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-345e0937-1892-4cf5-b96b-ee5c5b2aa8e8" }, { "id": "266faa5c-7b35-41e8-85e4-16fda5c858a4", "name": "Authentication Timeout", "originalRequest": { "method": "POST", "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/resultRankings/duplicate/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "duplicate", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-266faa5c-7b35-41e8-85e4-16fda5c858a4" }, { "id": "15783145-c153-46c7-a207-03ebd2a901cb", "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": "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/resultRankings/duplicate/:resultRankingId?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "duplicate", ":resultRankingId" ], "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": "resultRankingId" } ] } }, "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-15783145-c153-46c7-a207-03ebd2a901cb" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-1cf4890a-bbd1-48b6-bcd8-45048764e7df" } ], "id": "087e564a-6a4d-4c0d-a28c-0f0e636cd812", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-087e564a-6a4d-4c0d-a28c-0f0e636cd812" } ], "id": "8b0005f3-c236-4321-8730-84d476f5b95a", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-8b0005f3-c236-4321-8730-84d476f5b95a" }, { "name": "validate", "item": [ { "name": "batch", "item": [ { "name": "Validate a Batch of Result Ranking Operations.", "id": "e099dc12-69f1-4548-a51b-3ce6a8bff1fc", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "11138e4f-1489-40d5-ac5e-53e1f6f643f5", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "\n Validate that a list of operations would be accepted by our API and executed.\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": "1a19a2f2-6cc2-4446-bbc5-145b675ff424", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"sit__\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"autec\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n },\n {\n \"operationType\": \"\",\n \"operationValid\": \"\",\n \"resourceId\": \"\",\n \"validationErrors\": {\n \"esse_6\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-1a19a2f2-6cc2-4446-bbc5-145b675ff424" }, { "id": "df40b9b2-ed3a-4382-845d-dcf741a4d139", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-df40b9b2-ed3a-4382-845d-dcf741a4d139" }, { "id": "3916eb87-3d45-4c12-82ce-0eaf42517b42", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-3916eb87-3d45-4c12-82ce-0eaf42517b42" }, { "id": "54b7dd88-6560-4f2e-a8e8-3e21828aa0e8", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-54b7dd88-6560-4f2e-a8e8-3e21828aa0e8" }, { "id": "3acf570e-ad4c-4818-9607-36c4577739ea", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-3acf570e-ad4c-4818-9607-36c4577739ea" }, { "id": "cafe6432-7fdf-4afb-b40e-c38ea41b7945", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-cafe6432-7fdf-4afb-b40e-c38ea41b7945" }, { "id": "ff1d120a-ff7a-4c24-b526-8b530c982f0a", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-ff1d120a-ff7a-4c24-b526-8b530c982f0a" }, { "id": "158e07f0-01b9-46ec-84c7-d93ce1ffc231", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n },\n {\n \"operationType\": \"CREATE\",\n \"model\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"contains\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-158e07f0-01b9-46ec-84c7-d93ce1ffc231" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-e099dc12-69f1-4548-a51b-3ce6a8bff1fc" } ], "id": "2e5a77bd-b3fe-4ac2-8f60-b006d1b49cdf", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-2e5a77bd-b3fe-4ac2-8f60-b006d1b49cdf" }, { "name": "Validate a Single Result Ranking Operation.", "id": "7b0890c7-b83d-46bd-a74a-e9ee575cc1e8", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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": "565d34b4-8e2a-46fa-91ca-d990e51c6470", "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": "f291a6f6-8248-44c1-96d1-1691a7f6e4f0", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"ipsum_1\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n }\n }\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-f291a6f6-8248-44c1-96d1-1691a7f6e4f0" }, { "id": "50f97592-6dda-4025-9130-e73b5f67c546", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-50f97592-6dda-4025-9130-e73b5f67c546" }, { "id": "0a45f304-4712-4550-bc25-f548832db1e7", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-0a45f304-4712-4550-bc25-f548832db1e7" }, { "id": "7f0de40b-598d-46b5-ad73-0c48d65a3aa1", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-7f0de40b-598d-46b5-ad73-0c48d65a3aa1" }, { "id": "afcaba70-9f1b-4f42-a537-8f92d0c918cd", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-afcaba70-9f1b-4f42-a537-8f92d0c918cd" }, { "id": "2c7f4892-e398-46e0-a6ad-9a4a68c03595", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-2c7f4892-e398-46e0-a6ad-9a4a68c03595" }, { "id": "d7d410ac-5a86-4b7a-ba33-0d6dcb37d22f", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings", "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-d7d410ac-5a86-4b7a-ba33-0d6dcb37d22f" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-7b0890c7-b83d-46bd-a74a-e9ee575cc1e8" } ], "id": "3f9f5b05-15db-4ce0-a14a-d5ceef1aa465", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-3f9f5b05-15db-4ce0-a14a-d5ceef1aa465" }, { "name": "Get a List of Result Ranking Rules", "id": "6af0d013-a706-41d6-81ff-aed462f06849", "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/resultRankings?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&ruleStatuses=active&ruleStatuses=inactive&filter=&ruleTypes=featuredResults&ruleTypes=rankingExpressions&associatedGroups=&associatedGroups=&expand=condition.detailed&expand=condition.detailed&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.\n\n**Deprecated:** Use `ruleTypes` instead.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.\n\n**Deprecated:** Use `ruleStatuses` instead.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "active" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "inactive" }, { "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 rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "featuredResults" }, { "description": "The rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "rankingExpressions" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "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" } ], "variable": [ { "id": "b9be203e-1244-4abc-8697-13cdafe19108", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Get a list of result ranking rules\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "c19f6225-aae4-4cc2-9982-84d680eb1a90", "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/resultRankings?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&ruleStatuses=inactive&filter=&ruleTypes=rankingExpressions&associatedGroups=&expand=condition.detailed&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.\n\n**Deprecated:** Use `ruleTypes` instead.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.\n\n**Deprecated:** Use `ruleStatuses` instead.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "inactive" }, { "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 rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "rankingExpressions" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "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" } ], "variable": [ { "key": "pipelineId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"resultRankings\": [\n {\n \"id\": \"\",\n \"resultRanking\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"unspecified\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n }\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n },\n \"associatedGroup\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"expired\"\n }\n },\n {\n \"id\": \"\",\n \"resultRanking\": {\n \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"matches\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"is\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"contains\"\n },\n \"locale\": {\n \"kind\": \"all\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\",\n \"detailed\": {\n \"condition\": {\n \"operator\": \"\",\n \"left\": {\n \"value\": \"\"\n },\n \"right\": {\n \"value\": \"\"\n }\n }\n }\n },\n \"description\": \"\",\n \"enabled\": true,\n \"isMigrated\": true,\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n },\n \"associatedGroup\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"active\"\n }\n }\n ],\n \"totalCount\": \"\",\n \"totalPages\": \"\",\n \"groupedBy\": {\n \"groups\": {\n \"associated\": {\n \"quis5f\": \"\",\n \"pariatur_8\": \"\"\n },\n \"orphaned\": \"\"\n },\n \"status\": {\n \"active\": \"\",\n \"inactive\": \"\"\n },\n \"type\": {\n \"featuredResults\": \"\",\n \"rankingExpressions\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-c19f6225-aae4-4cc2-9982-84d680eb1a90" }, { "id": "3556fae8-ad38-485c-a23d-33c3fb4e9397", "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/resultRankings?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&ruleStatuses=inactive&filter=&ruleTypes=rankingExpressions&associatedGroups=&expand=condition.detailed&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.\n\n**Deprecated:** Use `ruleTypes` instead.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.\n\n**Deprecated:** Use `ruleStatuses` instead.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "inactive" }, { "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 rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "rankingExpressions" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-3556fae8-ad38-485c-a23d-33c3fb4e9397" }, { "id": "bab00829-f23e-4f5e-9381-5a7a9dfa92e3", "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/resultRankings?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&ruleStatuses=inactive&filter=&ruleTypes=rankingExpressions&associatedGroups=&expand=condition.detailed&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.\n\n**Deprecated:** Use `ruleTypes` instead.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.\n\n**Deprecated:** Use `ruleStatuses` instead.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "inactive" }, { "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 rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "rankingExpressions" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-bab00829-f23e-4f5e-9381-5a7a9dfa92e3" }, { "id": "546f0e9d-f30d-4ad5-a1b4-aaf4dbe4f50c", "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/resultRankings?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&ruleStatuses=inactive&filter=&ruleTypes=rankingExpressions&associatedGroups=&expand=condition.detailed&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.\n\n**Deprecated:** Use `ruleTypes` instead.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.\n\n**Deprecated:** Use `ruleStatuses` instead.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "inactive" }, { "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 rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "rankingExpressions" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-546f0e9d-f30d-4ad5-a1b4-aaf4dbe4f50c" }, { "id": "057d4752-518e-4315-8e17-ae954b54ddb5", "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/resultRankings?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&ruleStatuses=inactive&filter=&ruleTypes=rankingExpressions&associatedGroups=&expand=condition.detailed&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.\n\n**Deprecated:** Use `ruleTypes` instead.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.\n\n**Deprecated:** Use `ruleStatuses` instead.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "inactive" }, { "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 rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "rankingExpressions" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "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" } ], "variable": [ { "key": "pipelineId" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"statusCode\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\",\n \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-057d4752-518e-4315-8e17-ae954b54ddb5" }, { "id": "771607d7-3382-4cee-8c8b-01d1137f574b", "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/resultRankings?organizationId=&kind=&enabledStatus=&statementGroupId=&isOrderAscending=true&ruleStatuses=inactive&filter=&ruleTypes=rankingExpressions&associatedGroups=&expand=condition.detailed&page=0&perPage=20", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "The kind of result ranking rules to allow in the returned list (i.e., `featured_result` or `ranking_expression`).\n\nBy default, both kinds of rules are allowed.\n\n**Deprecated:** Use `ruleTypes` instead.", "key": "kind", "value": "" }, { "description": "The enabled status of result ranking rules to allow in the returned list.\n\nSet to `true` to only allow rules whose `enabled` property is set to `true`, and vice versa.\n\nBy default, both enabled and disabled rules are allowed.\n\n**Deprecated:** Use `ruleStatuses` instead.", "key": "enabledStatus", "value": "" }, { "description": "The unique identifier of the statement group.", "key": "statementGroupId", "value": "" }, { "description": "Whether to sort the results in ascending order.", "key": "isOrderAscending", "value": "true" }, { "description": "The rule status to allow in the results. Available statuses are: \"active\", \"inactive\".\n\nIf you leave this parameter undefined, all rule statuses will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleStatuses", "value": "inactive" }, { "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 rule types to allow in the results. Available types are \"featuredResults\", \"rankingExpressions\".\nIf you leave this parameter undefined, all rule types will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "ruleTypes", "value": "rankingExpressions" }, { "description": "The group names to allow in the results. Include the `null` value in the array to allow rules that are not associated with any groups (e.g., `[null, \"mygroup\"]`). If you leave this parameter undefined, all groups will be allowed in the results. If you pass an empty array (`[]`), no rules will be returned.", "key": "associatedGroups", "value": "" }, { "description": "The related resources to expand in the response.\n\nSet to `condition.detailed` to include the detailed version of the condition alongside `condition.reference` in each result ranking condition.", "key": "expand", "value": "condition.detailed" }, { "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" } ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-771607d7-3382-4cee-8c8b-01d1137f574b" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-6af0d013-a706-41d6-81ff-aed462f06849" }, { "name": "Create a New Result Ranking Rule", "id": "bf9bfa17-3a5f-4667-8990-d08884973800", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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": "1edec8e1-624c-47b4-90fe-74ad7d6c59d3", "key": "pipelineId", "value": "", "description": "(Required) The unique identifier of the target query pipeline." } ] }, "description": "Create a new result ranking rule\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n
" }, "response": [ { "id": "89ec137c-3192-4cb4-b366-a8aa70494829", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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 \"id\": \"\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-89ec137c-3192-4cb4-b366-a8aa70494829" }, { "id": "324d3d87-18b4-4e97-ab71-cc85f2631515", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-324d3d87-18b4-4e97-ab71-cc85f2631515" }, { "id": "51054321-ec3d-49cf-b584-dbf81275f97f", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-51054321-ec3d-49cf-b584-dbf81275f97f" }, { "id": "cab4ff7e-02dd-4652-a8e7-1adb913b663a", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-cab4ff7e-02dd-4652-a8e7-1adb913b663a" }, { "id": "301dc4c1-7868-4acf-b451-67bcc8c2bd38", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-301dc4c1-7868-4acf-b451-67bcc8c2bd38" }, { "id": "53f0b3b3-3862-4225-a471-f7b8e5c65be3", "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 \"kind\": \"featured_result\",\n \"name\": \"\",\n \"targets\": [\n {\n \"uniqueId\": \"\"\n },\n {\n \"uniqueId\": \"\"\n }\n ],\n \"defaultMatchOperator\": {\n \"kind\": \"is\"\n },\n \"predicates\": [\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n },\n {\n \"kind\": \"basicExpressionAndLocalePredicate\",\n \"basicQueryExpression\": \"\",\n \"matchOperator\": {\n \"kind\": \"matches\"\n },\n \"locale\": {\n \"kind\": \"specific\",\n \"code\": \"\"\n }\n }\n ],\n \"condition\": {\n \"reference\": \"\"\n },\n \"description\": \"\",\n \"enabled\": true,\n \"statementGroupId\": \"\",\n \"matchQuery\": false,\n \"matchAdvancedQuery\": true,\n \"includeInFacets\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/rest/search/v2/admin/pipelines/:pipelineId/resultRankings?organizationId=", "host": [ "{{baseUrl}}" ], "path": [ "rest", "search", "v2", "admin", "pipelines", ":pipelineId", "resultRankings" ], "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 \"nisie64\": \"laboris\"\n}", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-53f0b3b3-3862-4225-a471-f7b8e5c65be3" } ], "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-bf9bfa17-3a5f-4667-8990-d08884973800" } ], "id": "35541381-03da-4fc0-9817-0189fcd2a0f0", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-35541381-03da-4fc0-9817-0189fcd2a0f0" } ], "id": "4d0dcfe6-4342-4664-969a-0e63aeb36585", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-4d0dcfe6-4342-4664-969a-0e63aeb36585" } ], "id": "2d4d7f28-bf55-4c17-a06c-9df292f5179d", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-2d4d7f28-bf55-4c17-a06c-9df292f5179d" } ], "id": "15a93735-20fb-44bf-9364-49e826d0bd27", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-15a93735-20fb-44bf-9364-49e826d0bd27" } ], "id": "f501f7a2-f394-4a17-9eb7-22b2a88d9ffb", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-f501f7a2-f394-4a17-9eb7-22b2a88d9ffb" } ], "id": "b7fe7eb2-e026-4d81-ae87-c77b152d3f7b", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-b7fe7eb2-e026-4d81-ae87-c77b152d3f7b" } ], "id": "2695fcbb-7ca4-4ea4-947b-c8e3bc3e2e59", "createdAt": "2026-07-28T01:31:27.000Z", "updatedAt": "2026-07-28T01:31:27.000Z", "uid": "35240-2695fcbb-7ca4-4ea4-947b-c8e3bc3e2e59" } ], "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" } ] }