Logo

Reports API

APIs for managing reports.
Currently supports App Reports.

Get report types

Get report types

SecuritybearerAuth
Responses
200

Report types

400

Bad request

401

Unauthorized

500

Internal server error

get/report/v0/report-types
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Create Report
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.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
report_type
required
string
 Value: "device_apps"  
start_time
required
string <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.


 
end_time
required
string <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.


 
is_download
boolean
 
(DeviceAppsFilter (object or null))
 
Responses 
200
Create Report


400
Bad request


401
Unauthorized


500
Internal server error


post/report/v0/reports
Request samples 
application/json
{
  • "report_type": "device_apps",
  • "start_time": "2024-08-28T00:00:00Z",
  • "end_time": "2024-08-28T00:00:00Z",
  • "is_download": true,
  • "filters": {
    }
}
Response samples 
application/json
{
  • "content": {
    }
}
Get report status
Call this API with report ID generated from "Create Report" API to check the report generation status and retrieve the results. Learn more.


SecuritybearerAuth 
Request 
path Parameters
report_id
required
string <uuid> 
Report ID


 
Responses 
200
Report status


400
Bad request


401
Unauthorized


500
Internal server error


get/report/v0/reports/{report_id}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}