Skip to content

Create Report

Request

This API will return a report ID. Use this ID to call the "Get Report Status" API to check the report generation status and retrieve the results. Learn more.

Security
bearerAuth
Bodyapplication/jsonrequired
report_typestringrequired
Enum:"device_apps""device"
Example:"device_apps"
start_timestring, (date-time)

Start time of the report in UTC format. Example: "2024-08-28T00:00:00Z". Must be a date and time later than July 1st, 2024.

Example:"2024-08-28T00:00:00Z"
end_timestring, (date-time)

End time of the report in UTC format. Example: "2024-08-29T00:00:00Z". Must be a date and time later than July 1st, 2024 and equal to the start_time.

Example:"2024-08-28T00:00:00Z"
is_downloadboolean
filters(DeviceAppsFilter (object or null)) or (DeviceFilter (object or null))
One of:
cURL
curl -i -X POST \
  https://develop-api.esper.io/_mock/openapi/report/v0/reports \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "report_type": "device_apps",
    "start_time": "2024-08-28T00:00:00Z",
    "end_time": "2024-08-28T00:00:00Z",
    "is_download": true,
    "filters": {
      "date": "2024-08-28",
      "package_name": [
        "com.android.chrome"
      ],
      "app_state": [
        "SHOW"
      ],
      "device_os": [
        "Android"
      ],
      "platform": [
        "Android"
      ]
    }
  }'

Responses

Create Report

Bodyapplication/json
contentobject
Response
{
  "content": {
    "id": "string",
    "status": "PENDING"
  }
}