Accounts8

Analytics4

Applications1

Attachments4

Channels7

Comments6

Contact Groups10

Contact Handles2

Contact Lists10

Contact Notes2

Contacts11

Conversations20

Custom Fields7

Drafts5

Events2

Inboxes12

Knowledge Base Articles9

Knowledge Base Categories7

Knowledge Bases11

Links5

Message Template Folders11

Message Templates11

Messages7

Rules5

Shifts10

Signatures7

Statuses2

Tags14

Teammate groups14

Teammates5

Teams4

Time Off6

Token Identity1

Analytics

Create a new analytics export

Changed on Nov 3, 2026

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

Base URL
https://api2.frontapp.com
URL
https://api2.frontapp.com/analytics/exports
Auth
HTTP bearer

Request body

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
}

Changes

Nov 3, 2026d5ddea1da69e Revision changes
- breaking
  request body became required
- info
  the request property default value changed from Activity ID Type Source Message ID Segment ID Conversation ID Ticket IDs Segment Segment start Segment end Direction Status Status at activity time Inbox Inbox API ID Inbox at activity time Inbox API IDs at activity time Previous inbox IDs Message date Autoreply Reaction time Total reply time Handle time Response time Ticket resolution time Ticket replies to resolution Attributed to Assignee Author Contact name Contact handle Account names From To Cc Bcc Extract Tags Tag API IDs Tags at activity time Tag API IDs at activity time Tag application duration Activity API ID Message API ID Comment API ID Conversation API ID Message original ID New Conversation First response Business hours Subject Account name Survey rating Survey comment Segment closed Segment contains messages Last segment activity Added tag Added tag API ID Removed tag Removed tag API ID Segment cumulative teammates to Activity ID Type Source Message ID Segment ID Conversation ID Ticket IDs Segment Segment start Segment end Direction Status Status at activity time Inbox Inbox API ID Inbox at activity time Inbox API IDs at activity time Previous inbox IDs Message date Autoreply Reaction time Total reply time Handle time Response time Ticket resolution time Ticket replies to resolution Attributed to Assignee Author Contact name Contact handle Account names From To Cc Bcc Extract Tags Tag API IDs Tags at activity time Tag API IDs at activity time Tag application duration Activity API ID Message API ID Comment API ID Conversation API ID Message original ID New Conversation First response Business hours Subject Account name Survey rating Survey comment Segment closed Segment contains messages Last segment activity Added tag Added tag API ID Removed tag Removed tag API ID Segment cumulative teammates Attributed teammates
- info
  the request property default value changed from Message ID Segment ID Conversation ID Ticket IDs Segment Direction Status Inbox Inbox API ID Inbox at activity time Inbox API IDs at activity time Message date Autoreply Reaction time Total reply time Handle time Response time Attributed to Assignee Author Contact name Contact handle Account names From To Cc Bcc Extract Tags Tag API IDs Message API ID Conversation API ID New Conversation First response Business hours Subject Segment start Segment end Segment closed Last segment activity Segment cumulative teammates to Message ID Segment ID Conversation ID Ticket IDs Segment Direction Status Inbox Inbox API ID Inbox at activity time Inbox API IDs at activity time Message date Autoreply Reaction time Total reply time Handle time Response time Attributed to Assignee Author Contact name Contact handle Account names From To Cc Bcc Extract Tags Tag API IDs Message API ID Conversation API ID New Conversation First response Business hours Subject Segment start Segment end Segment closed Last segment activity Segment cumulative teammates Attributed teammates
- info
  added the new Attributed teammates enum value to the request property //////
- info
  added the new Attributed teammates enum value to the request property /////

Operation history