{
"opencollection": "1.0.0",
"info": {
"name": "Coveo Activity Activities Search V3 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": "Search V3",
"type": "folder"
},
"items": [
{
"info": {
"name": "Send Search Request",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3",
"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": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
}
],
"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": "See [Performing a Query](https://docs.coveo.com/en/1445/).\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Send Facet Search Request",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/facet",
"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": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
}
],
"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": "Executes a facet search request.\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Plan Search Execution",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/plan",
"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": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
}
],
"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": "See [Performing a Query](https://docs.coveo.com/en/1445/).\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Request Query Suggestions",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/querySuggest",
"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."
}
],
"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": "See [Getting Query Suggestions](https://docs.coveo.com/en/1459/).\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get Values for One Field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/values",
"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": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
}
],
"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": "Lists all values of the target field.\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get Values for Several Field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/values/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": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
},
{
"name": "analytics",
"value": "",
"type": "query"
}
],
"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": "Lists all values of the target field.\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get Item in JSON Format",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/search/v3/document",
"params": [
{
"name": "primaryId",
"value": "",
"type": "query",
"description": "The primary ID of the document."
},
{
"name": "uniqueId",
"value": "",
"type": "query",
"description": "**Deprecated:** Use `primaryId` instead.\n\nThe unique ID of the document."
},
{
"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": "pipeline",
"value": "",
"type": "query",
"description": "The name of the query pipeline to use for this request (bypassing its conditions, if it has any).\n\nYou can pass an empty `pipeline` value to use an empty query pipeline (i.e., `?pipeline=` or `\"pipeline\": \"\"`).\n\nIf a query does not contain the `pipeline` parameter, the first query pipeline whose conditions are met by the request is used (query pipelines without conditions are not evaluated). Should the request fail to meet the conditions of each evaluated query pipeline, the default query pipeline of the target Coveo Cloud organization is used (bypassing its conditions, if it has any).\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- For reporting purposes, when logging a **Search** usage analytics event for a query, the `queryPipeline` field of that event should be set to the final `pipeline` value used in the query execution. This value is determined from the query response. If no pipeline was specified, it uses the `\"default\"` value.\n- When using this parameter to list field values, not all query pipeline rules are supported. The only supported ones are [stop](https://docs.coveo.com/en/1446), [thesaurus](https://docs.coveo.com/en/3405) and [queryParamOverride](https://docs.coveo.com/en/1491).\n\nSee also [Managing Query Pipelines](https://docs.coveo.com/en/1450/).\n"
},
{
"name": "searchHub",
"value": "",
"type": "query",
"description": "The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- When logging a **Search** usage analytics event for a query, the `originLevel1` field of that event should be set to the value of the `searchHub` search request parameter.\n\nSee also the `tab` parameter.\n"
},
{
"name": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
},
{
"name": "locale",
"value": "",
"type": "query",
"description": "The locale of the current user. Must comply with IETF's [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt) definition.\n\nCoveo Machine Learning models use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.\n\n**Note:** When logging a **Search** usage analytics event, the `language` field of that event should match the language part of the `locale` value of the query (e.g., `en-US` in `locale` becomes `en` in `language`).\n"
},
{
"name": "timezone",
"value": "",
"type": "query",
"description": "The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time zone to use to correctly interpret dates in the query expression and result items.\n\nIf not specified, the default time zone of the server hosting the index is used.\n\n**Note:** While no Coveo Machine Learning model uses this information, it can nevertheless affect the ranking scores (and thus, potentially the order) of result items, as ranking expressions may be based on time constants.\n"
},
{
"name": "indexToken",
"value": "",
"type": "query",
"description": "The Base64 encoded identifier of the index mirror to forward the request to. See also the `index` parameter.\n\nIf you do not specify an `indexToken` (or `index`) value, any index mirror could be used.\n\n**Note:** Passing an `indexToken` (or `index`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "index",
"value": "",
"type": "query",
"description": "The identifier of the index mirror to forward the request to. See also the `indexToken` parameter.\n\nIf you do not specify an `index` (or `indexToken`) value, any index mirror could be used.\n\n**Note:** Passing an `index` (or `indexToken`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "logicalIndex",
"value": "",
"type": "query",
"description": "The identifier for a logical group of indexes that have been configured to include documents from the same sources.\n\nIf you do not specify a `logicalIndex` value, the `default` grouping will be used, typically including all indexes.\n"
},
{
"name": "tab",
"value": "",
"type": "query",
"description": "The second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel2` field of that event should be set to the `tab` value of the query (or to the `\"default\"` string, if no `tab` value was specified in the query).\n\n See also the `searchHub` parameter.\n"
},
{
"name": "referrer",
"value": "",
"type": "query",
"description": "The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the `document.referrer` value).\n\nCoveo Machine Learning models may use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel3` field of that event should be set to the `referrer` value of the query, if specified.\n\nSee also the `context` parameter.\n"
},
{
"name": "context",
"value": "",
"type": "query",
"description": "The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is either a string or an array of strings.\n\nCoveo Machine Learning models may use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$context` object.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `customData` field of that event should include the same data as the `context` parameter of the query. However, each `context` key included in `customData` must be prefixed by `context_` (e.g., the `userRoles` key in `context` becomes `context_userRoles` in `customData`).\n\nSee also the `referrer` parameter.\n\n**Example** `{\"userAgeRange\":\"25-35\",\"userRoles\":[\"PremiumCustomer\",\"ProductReviewer\"]}`\n"
}
],
"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": "\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get Item Data Stream",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/search/v3/datastream",
"params": [
{
"name": "dataStream",
"value": "",
"type": "query",
"description": "The name of the data stream to request."
},
{
"name": "primaryId",
"value": "",
"type": "query",
"description": "The primary ID of the document."
},
{
"name": "uniqueId",
"value": "",
"type": "query",
"description": "**Deprecated:** Use `primaryId` instead.\n\nThe unique ID of the document."
},
{
"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": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
},
{
"name": "contentType",
"value": "",
"type": "query",
"description": "The MIME type of the data stream to request.\n\n**Default:** `application/binary`"
},
{
"name": "pipeline",
"value": "",
"type": "query",
"description": "The name of the query pipeline to use for this request (bypassing its conditions, if it has any).\n\nYou can pass an empty `pipeline` value to use an empty query pipeline (i.e., `?pipeline=` or `\"pipeline\": \"\"`).\n\nIf a query does not contain the `pipeline` parameter, the first query pipeline whose conditions are met by the request is used (query pipelines without conditions are not evaluated). Should the request fail to meet the conditions of each evaluated query pipeline, the default query pipeline of the target Coveo Cloud organization is used (bypassing its conditions, if it has any).\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- For reporting purposes, when logging a **Search** usage analytics event for a query, the `queryPipeline` field of that event should be set to the final `pipeline` value used in the query execution. This value is determined from the query response. If no pipeline was specified, it uses the `\"default\"` value.\n- When using this parameter to list field values, not all query pipeline rules are supported. The only supported ones are [stop](https://docs.coveo.com/en/1446), [thesaurus](https://docs.coveo.com/en/3405) and [queryParamOverride](https://docs.coveo.com/en/1491).\n\nSee also [Managing Query Pipelines](https://docs.coveo.com/en/1450/).\n"
},
{
"name": "searchHub",
"value": "",
"type": "query",
"description": "The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- When logging a **Search** usage analytics event for a query, the `originLevel1` field of that event should be set to the value of the `searchHub` search request parameter.\n\nSee also the `tab` parameter.\n"
},
{
"name": "locale",
"value": "",
"type": "query",
"description": "The locale of the current user. Must comply with IETF's [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt) definition.\n\nCoveo Machine Learning models use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.\n\n**Note:** When logging a **Search** usage analytics event, the `language` field of that event should match the language part of the `locale` value of the query (e.g., `en-US` in `locale` becomes `en` in `language`).\n"
},
{
"name": "timezone",
"value": "",
"type": "query",
"description": "The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time zone to use to correctly interpret dates in the query expression and result items.\n\nIf not specified, the default time zone of the server hosting the index is used.\n\n**Note:** While no Coveo Machine Learning model uses this information, it can nevertheless affect the ranking scores (and thus, potentially the order) of result items, as ranking expressions may be based on time constants.\n"
},
{
"name": "indexToken",
"value": "",
"type": "query",
"description": "The Base64 encoded identifier of the index mirror to forward the request to. See also the `index` parameter.\n\nIf you do not specify an `indexToken` (or `index`) value, any index mirror could be used.\n\n**Note:** Passing an `indexToken` (or `index`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "index",
"value": "",
"type": "query",
"description": "The identifier of the index mirror to forward the request to. See also the `indexToken` parameter.\n\nIf you do not specify an `index` (or `indexToken`) value, any index mirror could be used.\n\n**Note:** Passing an `index` (or `indexToken`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "logicalIndex",
"value": "",
"type": "query",
"description": "The identifier for a logical group of indexes that have been configured to include documents from the same sources.\n\nIf you do not specify a `logicalIndex` value, the `default` grouping will be used, typically including all indexes.\n"
},
{
"name": "tab",
"value": "",
"type": "query",
"description": "The second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel2` field of that event should be set to the `tab` value of the query (or to the `\"default\"` string, if no `tab` value was specified in the query).\n\n See also the `searchHub` parameter.\n"
},
{
"name": "referrer",
"value": "",
"type": "query",
"description": "The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the `document.referrer` value).\n\nCoveo Machine Learning models may use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel3` field of that event should be set to the `referrer` value of the query, if specified.\n\nSee also the `context` parameter.\n"
},
{
"name": "context",
"value": "",
"type": "query",
"description": "The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is either a string or an array of strings.\n\nCoveo Machine Learning models may use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$context` object.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `customData` field of that event should include the same data as the `context` parameter of the query. However, each `context` key included in `customData` must be prefixed by `context_` (e.g., the `userRoles` key in `context` becomes `context_userRoles` in `customData`).\n\nSee also the `referrer` parameter.\n\n**Example** `{\"userAgeRange\":\"25-35\",\"userRoles\":[\"PremiumCustomer\",\"ProductReviewer\"]}`\n"
}
],
"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": "\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get HTML Item Preview",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/html",
"params": [
{
"name": "uniqueId",
"value": "",
"type": "query",
"description": "The uniqueId of the document. Exactly one of uniqueId or primaryId is required."
},
{
"name": "primaryId",
"value": "",
"type": "query",
"description": "The primaryId of the document. Exactly one of uniqueId or primaryId is required."
},
{
"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": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
},
{
"name": "findNext",
"value": "",
"type": "query"
},
{
"name": "findPrevious",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "enableNavigation",
"value": "",
"type": "query"
},
{
"name": "requestedOutputSize",
"value": "",
"type": "query",
"description": "The approximate number of bytes to request in the HTML response. **Default:** `0`, meaning that the entire HTML document is requested."
}
],
"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": "\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get Item in Text Format",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/search/v3/text",
"params": [
{
"name": "primaryId",
"value": "",
"type": "query",
"description": "The primary ID of the document."
},
{
"name": "uniqueId",
"value": "",
"type": "query",
"description": "**Deprecated:** Use `primaryId` instead.\n\nThe unique ID of the document."
},
{
"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": "pipeline",
"value": "",
"type": "query",
"description": "The name of the query pipeline to use for this request (bypassing its conditions, if it has any).\n\nYou can pass an empty `pipeline` value to use an empty query pipeline (i.e., `?pipeline=` or `\"pipeline\": \"\"`).\n\nIf a query does not contain the `pipeline` parameter, the first query pipeline whose conditions are met by the request is used (query pipelines without conditions are not evaluated). Should the request fail to meet the conditions of each evaluated query pipeline, the default query pipeline of the target Coveo Cloud organization is used (bypassing its conditions, if it has any).\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- For reporting purposes, when logging a **Search** usage analytics event for a query, the `queryPipeline` field of that event should be set to the final `pipeline` value used in the query execution. This value is determined from the query response. If no pipeline was specified, it uses the `\"default\"` value.\n- When using this parameter to list field values, not all query pipeline rules are supported. The only supported ones are [stop](https://docs.coveo.com/en/1446), [thesaurus](https://docs.coveo.com/en/3405) and [queryParamOverride](https://docs.coveo.com/en/1491).\n\nSee also [Managing Query Pipelines](https://docs.coveo.com/en/1450/).\n"
},
{
"name": "searchHub",
"value": "",
"type": "query",
"description": "The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- When logging a **Search** usage analytics event for a query, the `originLevel1` field of that event should be set to the value of the `searchHub` search request parameter.\n\nSee also the `tab` parameter.\n"
},
{
"name": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
},
{
"name": "locale",
"value": "",
"type": "query",
"description": "The locale of the current user. Must comply with IETF's [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt) definition.\n\nCoveo Machine Learning models use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.\n\n**Note:** When logging a **Search** usage analytics event, the `language` field of that event should match the language part of the `locale` value of the query (e.g., `en-US` in `locale` becomes `en` in `language`).\n"
},
{
"name": "timezone",
"value": "",
"type": "query",
"description": "The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time zone to use to correctly interpret dates in the query expression and result items.\n\nIf not specified, the default time zone of the server hosting the index is used.\n\n**Note:** While no Coveo Machine Learning model uses this information, it can nevertheless affect the ranking scores (and thus, potentially the order) of result items, as ranking expressions may be based on time constants.\n"
},
{
"name": "indexToken",
"value": "",
"type": "query",
"description": "The Base64 encoded identifier of the index mirror to forward the request to. See also the `index` parameter.\n\nIf you do not specify an `indexToken` (or `index`) value, any index mirror could be used.\n\n**Note:** Passing an `indexToken` (or `index`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "index",
"value": "",
"type": "query",
"description": "The identifier of the index mirror to forward the request to. See also the `indexToken` parameter.\n\nIf you do not specify an `index` (or `indexToken`) value, any index mirror could be used.\n\n**Note:** Passing an `index` (or `indexToken`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "logicalIndex",
"value": "",
"type": "query",
"description": "The identifier for a logical group of indexes that have been configured to include documents from the same sources.\n\nIf you do not specify a `logicalIndex` value, the `default` grouping will be used, typically including all indexes.\n"
},
{
"name": "tab",
"value": "",
"type": "query",
"description": "The second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel2` field of that event should be set to the `tab` value of the query (or to the `\"default\"` string, if no `tab` value was specified in the query).\n\n See also the `searchHub` parameter.\n"
},
{
"name": "referrer",
"value": "",
"type": "query",
"description": "The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the `document.referrer` value).\n\nCoveo Machine Learning models may use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel3` field of that event should be set to the `referrer` value of the query, if specified.\n\nSee also the `context` parameter.\n"
},
{
"name": "context",
"value": "",
"type": "query",
"description": "The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is either a string or an array of strings.\n\nCoveo Machine Learning models may use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$context` object.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `customData` field of that event should include the same data as the `context` parameter of the query. However, each `context` key included in `customData` must be prefixed by `context_` (e.g., the `userRoles` key in `context` becomes `context_userRoles` in `customData`).\n\nSee also the `referrer` parameter.\n\n**Example** `{\"userAgeRange\":\"25-35\",\"userRoles\":[\"PremiumCustomer\",\"ProductReviewer\"]}`\n"
}
],
"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": "\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "List All Fields",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/search/v3/fields",
"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": "pipeline",
"value": "",
"type": "query",
"description": "The name of the query pipeline to use for this request (bypassing its conditions, if it has any).\n\nYou can pass an empty `pipeline` value to use an empty query pipeline (i.e., `?pipeline=` or `\"pipeline\": \"\"`).\n\nIf a query does not contain the `pipeline` parameter, the first query pipeline whose conditions are met by the request is used (query pipelines without conditions are not evaluated). Should the request fail to meet the conditions of each evaluated query pipeline, the default query pipeline of the target Coveo Cloud organization is used (bypassing its conditions, if it has any).\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- For reporting purposes, when logging a **Search** usage analytics event for a query, the `queryPipeline` field of that event should be set to the final `pipeline` value used in the query execution. This value is determined from the query response. If no pipeline was specified, it uses the `\"default\"` value.\n- When using this parameter to list field values, not all query pipeline rules are supported. The only supported ones are [stop](https://docs.coveo.com/en/1446), [thesaurus](https://docs.coveo.com/en/3405) and [queryParamOverride](https://docs.coveo.com/en/1491).\n\nSee also [Managing Query Pipelines](https://docs.coveo.com/en/1450/).\n"
},
{
"name": "searchHub",
"value": "",
"type": "query",
"description": "The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Notes:**\n\n- This parameter will be overridden if the search request is authenticated by a [search token](https://docs.coveo.com/en/56/) that enforces a specific [`pipeline`](https://docs.coveo.com/en/56/#pipeline-string-optional), or a [`searchHub`](https://docs.coveo.com/en/56/#searchhub-string-optional) that routes queries to a specific `pipeline` via a query pipeline condition.\n- When logging a **Search** usage analytics event for a query, the `originLevel1` field of that event should be set to the value of the `searchHub` search request parameter.\n\nSee also the `tab` parameter.\n"
},
{
"name": "viewAllContent",
"value": "",
"type": "query",
"description": "Whether to bypass document permissions. Only effective if the access token grants the **Search - View all content** privilege."
},
{
"name": "locale",
"value": "",
"type": "query",
"description": "The locale of the current user. Must comply with IETF's [BCP 47](http://www.rfc-editor.org/rfc/bcp/bcp47.txt) definition.\n\nCoveo Machine Learning models use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$locale` object.\n\n**Note:** When logging a **Search** usage analytics event, the `language` field of that event should match the language part of the `locale` value of the query (e.g., `en-US` in `locale` becomes `en` in `language`).\n"
},
{
"name": "timezone",
"value": "",
"type": "query",
"description": "The [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) identifier of the time zone to use to correctly interpret dates in the query expression and result items.\n\nIf not specified, the default time zone of the server hosting the index is used.\n\n**Note:** While no Coveo Machine Learning model uses this information, it can nevertheless affect the ranking scores (and thus, potentially the order) of result items, as ranking expressions may be based on time constants.\n"
},
{
"name": "indexToken",
"value": "",
"type": "query",
"description": "The Base64 encoded identifier of the index mirror to forward the request to. See also the `index` parameter.\n\nIf you do not specify an `indexToken` (or `index`) value, any index mirror could be used.\n\n**Note:** Passing an `indexToken` (or `index`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "index",
"value": "",
"type": "query",
"description": "The identifier of the index mirror to forward the request to. See also the `indexToken` parameter.\n\nIf you do not specify an `index` (or `indexToken`) value, any index mirror could be used.\n\n**Note:** Passing an `index` (or `indexToken`) value has no effect when the results of a specific request can be returned from cache (see the `maximumAge` parameter).\n"
},
{
"name": "logicalIndex",
"value": "",
"type": "query",
"description": "The identifier for a logical group of indexes that have been configured to include documents from the same sources.\n\nIf you do not specify a `logicalIndex` value, the `default` grouping will be used, typically including all indexes.\n"
},
{
"name": "tab",
"value": "",
"type": "query",
"description": "The second level of origin of the request, typically the identifier of the selected tab in the graphical search interface from which the request originates.\n\nCoveo Machine Learning models use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel2` field of that event should be set to the `tab` value of the query (or to the `\"default\"` string, if no `tab` value was specified in the query).\n\n See also the `searchHub` parameter.\n"
},
{
"name": "referrer",
"value": "",
"type": "query",
"description": "The third level of origin of the request, typically the URL of the page that linked to the search interface from which the request originates (e.g., in JavaScript, this would correspond to the `document.referrer` value).\n\nCoveo Machine Learning models may use this information to provide contextually relevant output.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `originLevel3` field of that event should be set to the `referrer` value of the query, if specified.\n\nSee also the `context` parameter.\n"
},
{
"name": "context",
"value": "",
"type": "query",
"description": "The custom context information to send along with the request. Must be a dictionary of key-value pairs (JSON) where each key is a string, and each value is either a string or an array of strings.\n\nCoveo Machine Learning models may use this information to provide contextually relevant output. Moreover, this information can be referred to in query expressions and QPL statements by using the `$context` object.\n\n**Note:** When logging a **Search** usage analytics event for a query, the `customData` field of that event should include the same data as the `context` parameter of the query. However, each `context` key included in `customData` must be prefixed by `context_` (e.g., the `userRoles` key in `context` becomes `context_userRoles` in `customData`).\n\nSee also the `referrer` parameter.\n\n**Example** `{\"userAgeRange\":\"25-35\",\"userRoles\":[\"PremiumCustomer\",\"ProductReviewer\"]}`\n"
}
],
"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 all fields in the target Coveo Cloud organization.\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Find Fields from Results of a Query Expression",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/fields/find",
"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."
}
],
"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": "Find fields name from results matching the `q` expression.\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"},\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"VIEW_ALL_CONTENT\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Create Search Token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/token",
"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."
}
],
"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 temporary [JSON web token](https://jwt.io/) which can be used to impersonate one or several security identities when authenticating a query (see [Search Token Authentication](https://docs.coveo.com/en/56/)).\n\nPrivilege(s) required
\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"IMPERSONATE_SEARCH_API\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Log in to Authentication Provider",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/search/v3/login/:provider",
"params": [
{
"name": "provider",
"value": "My SharePoint Server",
"type": "path",
"description": "The name of the Search API authentication provider to log in to."
},
{
"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": "Directs the browser to URI of the target Search API authentication provider, and back to the origin search page once the authentication process is complete. This authentication provider must be properly configured in the Coveo Cloud organization.\n\nPrivilege(s) required
\n\n```json\n\n```\n "
}
]
}
],
"bundled": true
}