Skip to content

Get group report
Stable

Request

⚠️ Legacy feature. Android only. Daily and Custom Reports are a legacy feature. For current reporting needs, use the Reports API: GET /report/v0/report-types, POST /report/v0/reports, and GET /report/v0/reports/{report_id}.

Returns device count summaries broken down by device group for a specified date-time range. Use this endpoint to get group-level device status aggregates — active, inactive, registered, new, and disabled counts — without per-device detail records.

About Get Group Report

The group report provides a fleet view organized by Esper device groups, returning one GroupReport object per group within the specified date window. It is a leaner alternative to the device report when group-level aggregates are all that's needed. Both start_date and end_date are required.

Security
esper_cloud_api_apiKey
Query
start_datestring, (date-time)required

Start date of range in which to retrieve group report.

end_datestring, (date-time)required

End date of range in which to retrieve group report.

syncboolean

Sync device status report to specified field

Default:true
cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/enterprise/report/group-report/?start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z&sync=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful operation

Bodyapplication/json
Array [
group_idstring, (uuid)
group_namestring
group_pathstring
active_devicesinteger
inactive_devicesinteger
registered_devicesinteger
new_devicesinteger
disabled_devicesinteger
]
Response
[
  {
    "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
    "group_name": "string",
    "group_path": "string",
    "active_devices": 0,
    "inactive_devices": 0,
    "registered_devices": 0,
    "new_devices": 0,
    "disabled_devices": 0
  }
]