Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Analytics

Fetch an analytics report

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

Required scope: analytics:read

get/analytics/reports/{report_uid}

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"
    }
  ]
}