FRfrontapp
Analytics

Fetch an analytics report

Changed on

Fetch an analytics report. Refer to the Analytics topic for details about specific metrics.

Required scope: analytics:read

get/analytics/reports/{report_uid}

Request

  • Base URL
    https://api2.frontapp.com
  • URL
    https://api2.frontapp.com/analytics/reports/{report_uid}
  • Auth
    HTTP bearer

Path parameters

report_uidstring required

The report UID.

Response

An analytics report.

uidstring required

The UID of the analytics report

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

Status of the report.

progressinteger required

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

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/analytics/reports/b45efa66237cc453252d9019449c7a64f5cfdb491b6c2c1d6df33c1050d60e33"
  },
  "uid": "b45efa66237cc453252d9019449c7a64f5cfdb491b6c2c1d6df33c1050d60e33",
  "status": "done",
  "progress": 100,
  "metrics": [
    {
      "type": "number"
    }
  ]
}

Changes

  • d5ddea1da69eRevision changes
    • warning

      added the new avg_first_reaction_time enum value to the // response property for the response status

    • warning

      added the new avg_reaction_time enum value to the // response property for the response status

    • warning

      added the new avg_tag_duration enum value to the // response property for the response status

    • warning

      added the new num_active_accounts enum value to the // response property for the response status

    • warning

      added the new num_active_teammates enum value to the // response property for the response status

    • warning

      added the new num_assigned_segments enum value to the // response property for the response status

    • warning

      added the new num_new_tasks enum value to the // response property for the response status

    • warning

      added the new num_non_replies_sent enum value to the // response property for the response status

    • warning

      added the new num_replies_sent enum value to the // response property for the response status

    • warning

      added the new num_segments_with_outbounds enum value to the // response property for the response status

    • warning

      added the new num_segments_with_tag_changes enum value to the // response property for the response status

    • warning

      added the new num_tags_added enum value to the // response property for the response status

    • warning

      added the new num_tags_removed enum value to the // response property for the response status

    • warning

      added the new num_touched_segments enum value to the // response property for the response status

    • warning

      added the new pct_messages_with_message_templates enum value to the // response property for the response status