{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Statements V1 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": "Statements V1",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Query Pipeline Statements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "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": "sortBy",
                "value": "",
                "type": "query",
                "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`"
              },
              {
                "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."
              },
              {
                "name": "feature",
                "value": "",
                "type": "query",
                "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature."
              },
              {
                "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."
              }
            ],
            "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": "Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Create Query Pipeline Statement",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements",
            "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": "Creates a new query pipeline statement in a specific query 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": "Get Query Pipeline Statement",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/:statementId",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target statement."
              },
              {
                "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."
              }
            ],
            "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": "Gets a single query pipeline statement from a specific query pipeline.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Update Query Pipeline Statement",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/:statementId",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target statement."
              },
              {
                "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": "Updates a single query pipeline statement in a specific query 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": "Delete Query Pipeline Statement",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/:statementId",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target statement."
              },
              {
                "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."
              }
            ],
            "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 single query pipeline statement from a specific query 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": "Move Query Pipeline Statement",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/:statementId/move",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "statementId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target statement."
              },
              {
                "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": "Sets the position of a query pipeline statement in a specific query pipeline and updates other statement positions as appropriate.\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": "List Query Pipeline Statements",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/bulkGet",
            "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."
              },
              {
                "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": "sortBy",
                "value": "",
                "type": "query",
                "description": "The sort criteria to apply on the results.\n\n**Allowed values:** `definition`, `description`, and `position`.\n\n**Default:** `position`"
              },
              {
                "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."
              },
              {
                "name": "feature",
                "value": "",
                "type": "query",
                "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature."
              }
            ],
            "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": "Gets a sorted page of query pipeline statements matching certain criteria from a specific query pipeline.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Copy Query Pipeline Statements",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/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 statements from an origin to a target query pipeline. Using the same pipeline as origin and target will duplicate the specified statements in that pipeline.\n<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": "Export Query Pipeline Statements",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/export",
            "params": [
              {
                "name": "pipelineId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target query pipeline."
              },
              {
                "name": "feature",
                "value": "",
                "type": "query",
                "description": "The query pipeline feature to match.\n\n**Allowed values:** `when`, `filter`, `trigger`, `stop`, `thesaurus`, `topClicks`, `querySuggest`, `rankingweight`, `recommendation`, and `queryParamOverride`.\n\nBy default, results are not required to match a specific query pipeline feature."
              },
              {
                "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."
              }
            ],
            "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": "Exports the definition, condition, and description of statements from a specific query pipeline to a CSV file.\n<details>\n<summary>Privilege(s) required</summary>\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"QUERY_PIPELINE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Validate a Single Statement Operation.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/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\":\"EDIT\",\"targetId\":\"{pipelineId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Validate a Batch of Statement Operations.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/search/v1/admin/pipelines/:pipelineId/statements/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": "\r\n Validate that a list of operations would be accepted by our API and executed.\r\n A maximum of 15 can be processed per request.\n<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
}