{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Exports API - Version 14 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": "Exports API - Version 14", "type": "folder" }, "items": [ { "info": { "name": "Get Information on an Export", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v14/exports/:exportId", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" }, { "name": "exportId", "value": "", "type": "path", "description": "The export's unique identifier." }, { "name": "redirect", "value": "", "type": "query", "description": "Whether to return a HTTP redirect to the actual file.\n\n Note: for technical reasons, setting this parameter to true will yield an error when calling the endpoint through Swagger user interface." } ] }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Delete an Export", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/v14/exports/:exportId", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" }, { "name": "exportId", "value": "", "type": "path", "description": "The export's unique identifier." } ] }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Estimate the Number of Rows in an Export", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v14/exports/estimate", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" }, { "name": "from", "value": "", "type": "query", "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "to", "value": "", "type": "query", "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "f", "value": "", "type": "query", "description": "The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator." }, { "name": "fs", "value": "", "type": "query", "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator." }, { "name": "fc", "value": "", "type": "query", "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator." } ] }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Estimate the Number of Rows in a Visit Export", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v14/exports/visits/estimate", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" }, { "name": "from", "value": "", "type": "query", "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "to", "value": "", "type": "query", "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "f", "value": "", "type": "query", "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator." }, { "name": "fn", "value": "", "type": "query", "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator." } ] }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Lists All Exports", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v14/exports", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" } ] }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Generate an Export", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/v14/exports", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" }, { "name": "from", "value": "", "type": "query", "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "to", "value": "", "type": "query", "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "f", "value": "", "type": "query", "description": "The filter that will be applied to the events common dimensions (shared by all types of events). Multiple filter parameters are joined with the AND operator." }, { "name": "fs", "value": "", "type": "query", "description": "The filter that will be applied to the click and search events dimensions. Multiple filter parameters are joined with the AND operator." }, { "name": "fc", "value": "", "type": "query", "description": "The filter that will be applied to the custom events dimensions. Multiple filter parameters are joined with the AND operator." }, { "name": "filename", "value": "", "type": "query", "description": "Can only contain US-ASCII characters. If none is supplied it will be set to the export's id." }, { "name": "format", "value": "", "type": "query", "description": "The format of the generated CSV files." } ] }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Generate a Visit Export", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/v14/exports/visits", "params": [ { "name": "org", "value": "", "type": "query", "description": "The name of the organization (Coveo Cloud V2 only)" }, { "name": "from", "value": "", "type": "query", "description": "The beginning date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "to", "value": "", "type": "query", "description": "The end date of the date range. ISO8601 format 'YYYY-MM-DDThh:mm:ss.sssZ'" }, { "name": "f", "value": "", "type": "query", "description": "The filter that will be applied to the events dimensions. Multiple filter parameters are joined with the AND operator." }, { "name": "fn", "value": "", "type": "query", "description": "The filter that will be applied to dimensions to exclude events from the results. Multiple filter parameters are joined with the AND operator." }, { "name": "filename", "value": "", "type": "query", "description": "Can only contain US-ASCII characters. If none is supplied it will be set to the export's id." }, { "name": "d", "value": "", "type": "query", "description": "Export's description." }, { "name": "format", "value": "", "type": "query", "description": "The format of the generated CSV files." } ] }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Health Check for the Exports Service", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v14/exports/monitoring/health" }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." }, { "info": { "name": "Get the Exports Service Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/v14/exports/status" }, "docs": "This endpoint is deprecated and will be removed on October 1st, 2024." } ] } ], "bundled": true }