Logo

Daily and Custom Reports

Get report information

Returns report information

SecurityapiKey
Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/enterprise/report/info/
Request samples 
Response samples 
application/json
{
  • "reportAvailabilityFrom": "2019-08-24T14:15:22Z",
  • "enableReportsWorkflow": true
}
Get device status reports within specified date-time range
Returns device status reports within specified date-time range


SecurityapiKey 
Request 
query Parameters
start_date
required
string <date-time> 
Start date of range in which to retrieve device status reports


 
end_date
required
string <date-time> 
End date of range in which to retrieve device status reports


 
sync
boolean
 Default:  true
Sync device status report to specified field


 
fields
string
List of fields to add to device status report, comma separated


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/device-report/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get enterprise report
Returns enterprise report of devices within specified date-time range


SecurityapiKey 
Request 
query Parameters
start_date
required
string <date-time> 
Start date of range in which to retrieve enterprise report.


 
end_date
required
string <date-time> 
End date of range in which to retrieve enterprise report.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/enterprise-report/
Request samples 
Response samples 
application/json
{
  • "peak_active_devices": 0,
  • "provisioned_devices": 0,
  • "registered_devices": 0
}
Get group report
Returns group report of devices within specified date-time range


SecurityapiKey 
Request 
query Parameters
start_date
required
string <date-time> 
Start date of range in which to retrieve group report.


 
end_date
required
string <date-time> 
End date of range in which to retrieve group report.


 
sync
boolean
 Default:  true
Sync device status report to specified field


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/group-report/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get list of subscription reports
Returns list of subscription reports


SecurityapiKey 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/subscription/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Post subscription to enterprise
Returns instance of created subscription


SecurityapiKey 
Request 
Request Body schema: application/json
required
email_ids
required
Array of strings <email> 
 
Responses 
201
Successful Operation


400
Bad request


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


500
Internal server error


post/enterprise/report/subscription/
Request samples 
application/json
{
  • "email_ids": [
    ]
}
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Get instance of subscription
Returns instance of subscription


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/enterprise/report/subscription/{subscription_id}/
Request samples 
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Update subscription
Returns instance of updated subscription


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription.


 
Request Body schema: application/json
required
email_ids
required
Array of strings <email> 
 
is_subscribed
boolean
 
Responses 
200
successful operation


400
Invalid request.


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


put/enterprise/report/subscription/{subscription_id}/
Request samples 
application/json
{
  • "email_ids": [
    ],
  • "is_subscribed": true
}
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Partially update subscription
Returns instance of updated subscription


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription.


 
Request Body schema: application/json
email_ids
Array of strings <email> 
 
is_subscribed
boolean
 
Responses 
200
successful operation


400
Invalid request.


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


patch/enterprise/report/subscription/{subscription_id}/
Request samples 
application/json
{
  • "email_ids": [
    ],
  • "is_subscribed": true
}
Response samples 
application/json
{
  • "id": 0,
  • "email_ids": [
    ],
  • "is_subscribed": true,
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}
Deletes instance of subscription
Empty response


SecurityapiKey 
Request 
path Parameters
subscription_id
required
integer
A integer value identifying the subscription.


 
Responses 
204
The resource was deleted successfully.


400
Invalid request.


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


404
Not Found.


500
Internal server error


delete/enterprise/report/subscription/{subscription_id}/
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}
➔ Next to Connections