Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Analytics

Create a new analytics export

Create a new analytics export of messages or events (activities) over a specific time span. The export will be executed asynchronously. The response will include a link that can be used to retrieve the export status & result. Refer to the Analytics topic for details about specific metrics.

Required scope: analytics:read

post/analytics/exports

Request body

OR

Response

An analytics export.

idstring required

The public ID of the analytics export

status'running' | 'done' | 'too_big' | 'failed' required

Status of the analytics

progressinteger required

Number ranging from 0 to 100 corresponding to the percentage of the analytics processed.

urlstring

The URL from which the export data can be downloaded. Only displays after you make a GET request to the link included in the POST response.

filenamestring

The filename of the export with extension included. Only displays after you make a GET request to the link included in the POST response.

sizenumber nullable

Size (in bytes) of the export data. Only displays after you make a GET request to the link included in the POST response.

created_atnumber

Timestamp (in seconds) at which the export was requested.

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/analytics/exports/exp_o9y1a"
  },
  "id": "exp_o9y1a",
  "status": "running",
  "progress": 20,
  "url": "https://api.frontapp.com/analytics/exports/exp_o9y1a/download",
  "filename": "export-messages-yourCompany-2023-07-19-212d-e55df0.csv",
  "size": 26639,
  "created_at": 1703103649.159
}