{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Analysis 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": "Analysis V3", "type": "folder" }, "items": [ { "info": { "name": "Convert Query to Structured Expression", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/search/v3/analysis/expressions/structured", "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": "Parses a query expression written using the Coveo query syntax, and converts it into a structured expression.\nto a structured expression.\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXPRESSION_VALIDATION_RESULT\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Replay a Query with Inspection Details", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/search/v3/analysis/inspect/replay", "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": "Replay a query that was already done and get inspection details.\n\n**Note:** This API call can only be used with an OAuth token. API Keys and Search Token aren't allowed.\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\":\"REPLAY_ANY_QUERY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" } ] } ], "bundled": true }