{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Result rankings API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Result rankings",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a List of Result Ranking Rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "kind",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "enabledStatus",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "statementGroupId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the statement group."
              },
              {
                "name": "isOrderAscending",
                "value": "",
                "type": "query",
                "description": "Whether to sort the results in ascending order."
              },
              {
                "name": "ruleStatuses",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "ruleTypes",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "associatedGroups",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of results to get."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include per page."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a list of result ranking rules\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create a New Result Ranking Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a new result ranking rule\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Get a Result Ranking Rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "resultRankingId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the result ranking."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get a result ranking rule\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update a Result Ranking Rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "resultRankingId",
                "value": "120deecf-7822-4d7b-885f-53f184a3a76c",
                "type": "path",
                "description": "The unique identifier of the result ranking."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Update a result ranking rule\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Delete a Result Ranking Rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/:resultRankingId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "resultRankingId",
                "value": "120deecf-7822-4d7b-885f-53f184a3a76c",
                "type": "path",
                "description": "The unique identifier of the result ranking."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes a result ranking rule\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Bulk Get Result Ranking Rules",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/bulkGet",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "kind",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "enabledStatus",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "statementGroupId",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the statement group."
              },
              {
                "name": "isOrderAscending",
                "value": "",
                "type": "query",
                "description": "Whether to sort the results in ascending order."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "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."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of results to get."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of results to include per page."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Bulk get result ranking rules\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Bulk Delete Result Rankings Rules from a Pipeline",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/bulkDelete",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete multiple result rankings rules in batch for a specific pipeline.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Copy Result Rankings Rules to a Pipeline.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/copy",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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<details>\n<summary>Privilege(s) required</summary>\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</details>"
        },
        {
          "info": {
            "name": "Duplicate a Result Ranking Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/duplicate/:resultRankingId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "resultRankingId",
                "value": "120deecf-7822-4d7b-885f-53f184a3a76c",
                "type": "path",
                "description": "The unique identifier of the result ranking."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Duplicate a result ranking rule\n<details>\n<summary>Privilege(s) required</summary>\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</details>"
        },
        {
          "info": {
            "name": "Validate a Single Result Ranking Operation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Validate that a specific operation would be accepted by our API and executed.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Validate a Batch of Result Ranking Operations.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v2/admin/pipelines/:pipelineId/resultRankings/validate/batch",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organization",
                "type": "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."
              },
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
              "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "\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<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}