{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Passages Alpha 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": "Passages Alpha", "type": "folder" }, "items": [ { "info": { "name": "Allow to Debug Passage(s) Retrieval.", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/search/alpha/passages/retrieve/debug", "params": [ { "name": "organizationId", "value": "", "type": "query", "description": "The unique identifier of the target Coveo Cloud organization." }, { "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": "API that allows to debug how the passage(s) retrieval was performed for a particular query.\n\n**Note**: The debug endpoint of the Passage Retrieval API is currently in alpha.\n\n
\nPrivilege(s) required\n\n```json\n{\"level\":\"NORMAL\",\"owner\":\"SEARCH_API\",\"targetDomain\":\"EXECUTE_QUERY\",\"type\":\"ENABLE\",\"targetId\":\"*\"}\n```\n
" } ] } ], "bundled": true }