MDR Usage Reports

MDR Usage Report operations

Create an MDR usage report

Check the status and retrieve a MDR Usage Report with a call to GET /reporting/mdr_usage_reports/{id}. MDR Usage Reports are available for 30 days.

Request
Request Body schema: application/json

Mdr Usage Report to add

start_time
required
string

UTC (2022-07-29T00:00:00+00:00)

end_time
string

UTC (2022-07-29T06:21:27+00:00). Must be less than 24 hours from now

aggregation_type
integer
Default: 0

Aggregate: All = 0, By Profile = 1

profiles
Array of strings

Array of profile IDs

Responses
200

MdrUsageReport response

Response Schema: application/json
id
required
string
start_time
required
string

UTC (2022-07-29T00:00:00+00:00)

end_time
required
string

UTC (2022-07-29T06:21:27+00:00)

aggregation_type
required
integer
Default: 0

Aggregate by: All = 0, By Profile = 1

status
required
integer
Default: 1

Pending = 1, Complete = 2, Failed = 3, Expired = 4

report_url
required
string

Link to report

result
required
object

Report results

created_at
required
string
updated_at
required
string
profiles
Array of strings

Array of profile IDs

400

Bad request

401

Unauthorized

post/reporting/mdr_usage_reports
Request samples
application/json
{
  • "start_time": "string",
  • "end_time": "string",
  • "aggregation_type": 0,
  • "profiles": [
    • "string"
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "start_time": "string",
  • "end_time": "string",
  • "aggregation_type": 0,
  • "status": 1,
  • "report_url": "string",
  • "result": { },
  • "created_at": "string",
  • "updated_at": "string",
  • "profiles": [
    • "string"
    ]
}

List all MDR usage reports

Returns a list of your MDR usage reports.

Request
query Parameters
page
integer
Default: 1

Page number of results to load

per_page
integer <= 1000
Default: 100

Number of results per page

Responses
200

Mdr Usage Report response

Response Schema: application/json
Array
id
required
string
start_time
required
string

UTC (2022-07-29T00:00:00+00:00)

end_time
required
string

UTC (2022-07-29T06:21:27+00:00)

aggregation_type
required
integer
Default: 0

Aggregate by: All = 0, By Profile = 1

status
required
integer
Default: 1

Pending = 1, Complete = 2, Failed = 3, Expired = 4

report_url
required
string

Link to report

result
required
object

Report results

created_at
required
string
updated_at
required
string
profiles
Array of strings

Array of profile IDs

401

Unauthorized

get/reporting/mdr_usage_reports
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "start_time": "string",
    • "end_time": "string",
    • "aggregation_type": 0,
    • "status": 1,
    • "report_url": "string",
    • "result": { },
    • "created_at": "string",
    • "updated_at": "string",
    • "profiles": [
      • "string"
      ]
    }
]
Retrieve MDR usage report status
Retrieve the status of an MDR usage report. Response includes a link to the report once it is generated.


Request 
path Parameters
id
required
string
ID of MDR Usage Report to retrieve


 
Responses 
200
mdr_usage_report


Response Schema: application/json
id
required
string
 
start_time
required
string
UTC (2022-07-29T00:00:00+00:00)


 
end_time
required
string
UTC (2022-07-29T06:21:27+00:00)


 
aggregation_type
required
integer
 Default:  0
Aggregate by: All = 0, By Profile = 1


 
status
required
integer
 Default:  1
Pending = 1, Complete = 2, Failed = 3, Expired = 4


 
report_url
required
string
Link to report


 
result
required
object
Report results


 
created_at
required
string
 
updated_at
required
string
 
profiles
Array of strings
Array of profile IDs


 
401
Unauthorized


404
Resource not found


get/reporting/mdr_usage_reports/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "start_time": "string",
  • "end_time": "string",
  • "aggregation_type": 0,
  • "status": 1,
  • "report_url": "string",
  • "result": { },
  • "created_at": "string",
  • "updated_at": "string",
  • "profiles": [
    • "string"
    ]
}
Delete an MDR usage report
Permanently delete an MDR usage report.


Request 
path Parameters
id
required
string
ID of MDR Usage Report to delete


 
Responses 
200
MDR Usage Report delete response


Response Schema: application/json
success
required
boolean
 
message
required
string
 
401
Unauthorized


404
Resource not found


delete/reporting/mdr_usage_reports/{id}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "message": "string"
}