{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Logs 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": "Logs", "type": "folder" }, "items": [ { "info": { "name": "Get Specified Source Document Logs", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "sourceId", "value": "", "type": "query" }, { "name": "documentId", "value": "", "type": "query" }, { "name": "tasks", "value": "", "type": "query" }, { "name": "operations", "value": "", "type": "query" }, { "name": "results", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "perPage", "value": "", "type": "query" } ], "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 Specified Source Document Logs" }, { "info": { "name": "Get Indexing Pipeline Logs", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud organization.\nExample: `mycoveocloudorganizationg8tp8wu3`" }, { "name": "from", "value": "", "type": "query", "description": "The date and time (in W3C format, see [Date and Time Formats](https://www.w3.org/TR/NOTE-datetime)) corresponding to the beginning of the range for which to retrieve indexing pipeline logs.\nExample: `2018-05-22T23:36:30.589Z`" }, { "name": "to", "value": "", "type": "query", "description": "The date and time (in W3C format, see [Date and Time Formats](https://www.w3.org/TR/NOTE-datetime)) corresponding to the end of the range for which to retrieve indexing pipeline logs.\nThe end range must be within a week of the beginning range.\nExample: `2018-05-22T23:36:30.589Z`" }, { "name": "documentId", "value": "", "type": "query", "description": "The filter string against which to match document `uri` field values. See the `documentIdMatching` parameter to set the target kind of filter.
For example, setting the `documentId` parameter to `/attachment/` and setting the `documentIdMatching` parameter to `PARTIAL` means that the service will only retrieve logs of items whose `uri` field values contain the `/attachment/` substring." }, { "name": "documentIdMatching", "value": "", "type": "query", "description": "The kind of filter to apply when matching the target `documentId` value against document `uri` field values.
**Allowed values:**
- `EXACT`: the `documentId` value must match exactly the document URI.
- `PARTIAL`: the `documentId` values must be a substring of the document URI.
- `WILDCARD`: the `documentId` may contain the wildcards `*` (one or more characters) and `?` (a single character) to match against document URIs.
**Default:** `EXACT`" }, { "name": "page", "value": "", "type": "query", "description": "The 0-based index number of the page to retrieve.\nExample: `5`" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of indexing pipeline log entries to retrieve per page.\nExample: `50`" } ], "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": "Retrieves a page of indexing pipeline logs for a given time interval in a specific Coveo Cloud organization." } ] } ], "bundled": true }