Create a new analytics export

post

https://api2.frontapp.com/analytics/exports

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

Body Params

columns

array of objects

required

Defaults 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

List of the columns to include in the export.

columns*

type

string

enum

required

The type of export to create. The type you specify determines which columns are available for the export.

Allowed:

start

number

required

Start time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded down to the start of the day.

end

number

required

End time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded up to the end of the day.

timezone

string

IANA name of the timezone to format the dates with. If omitted, the export will use Etc/UTC.

filters

Resources to compute the analytics for. Defaults to all.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

201An analytics export.