Post Dashboard Usage
Description
Get all activity usage trend data of all the monitoring cloud accounts in the business unit.
URL
/api/v1/dashboard/usage
Method: Post
Request Headers
|
Key |
Value |
Type |
Description |
|---|---|---|---|
| Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCASB |
| Content-Type | application/json | String | |
|
buId |
<Business Unit ID> |
Long |
The targeted business unit ID on FortiCASB. Business unit ID can be obtained through . Alternatively, it can also be obtained from the REST API Get Resource Map |
|
timeZone |
<Time Zone> |
String |
Numeric representation of time zone of the user, ex. +0800. |
| companyId | <Company ID> | Integer | Company ID of which the business unit is under, can be obtained through Get Resource Map. |
|
roleId |
<User ID> |
Integer |
Login user ID, can be obtained through Get Resource Map. |
Request Body Parameters
|
Name |
Type |
Description |
|---|---|---|
| startTime | long | Timestamp, starting time of filtered open alerts |
| endTime | long | Timestamp, ending time of filtered open alerts |
Sample Request
|
Request URL |
POST https://www.forticasb.com/api/v1/dashboard/usage |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json timeZone: +0800 buid: 6384 roleId: 36241 companyId: 62598 |
| Request Body |
{ "startTime":1583865778729, "endTime":1583952178729 } |
Response Variables
|
Name |
Type |
Description |
|---|---|---|
| name | String | Cloud service name |
| id | String | Usage sequence number |
| key | String | The time that the usage was detected |
| value | long | The usage number at the date |
Sample Response
{
"data": [
{
"name": "Box",
"values": [
{
"id": "0",
"key": "2020-03-10T18:30:00+0000",
"value": 0
}
]
},
{
"name": "Salesforce",
"values": [
{
"id": "0",
"key": "2020-03-10T18:30:00+0000",
"value": 0
}
]
},
{
"name": "Dropbox",
"values": [
{
"id": "0",
"key": "2020-03-10T18:30:00+0000",
"value": 0
}
]
},
{
"name": "Google",
"values": [
{
"id": "0",
"key": "2020-03-10T18:30:00+0000",
"value": 0
}
]
},
{
"name": "Office365",
"values": [
{
"id": "0",
"key": "2020-03-10T18:30:00+0000",
"value": 0
}
]
}
]
}