Get Dashboard Statistics
Description
Get crucial statistics data from the cloud service in the business unit.
URL
/api/v1/dashboard/statistics
Method: POST
Request Headers
Key |
Value |
Type |
Description |
---|---|---|---|
Authorization | Bearer <Authorization Token> | String | Authorization credential generated by FortiCASB |
buId |
<Business unit ID> |
Long |
The targeted business unit ID on FortiCASB. Business unit ID can be obtained through View or Remove Business User. 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. |
service |
<Salesforce> |
String |
Cloud service account |
Content-Type | application/json | String |
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/statistics |
Request Header |
Authorization: Bearer <Authorization_Token> timeZone: +0800 Content-Type: application/json Service: Salesforce buid: 6384 |
Request Body |
{ "startTime":1583865778729, "endTime":1583952178729 } |
Response Variables
Name |
Type |
Description |
---|---|---|
topRiskUsers | List | Top risk users in a time period |
topRiskObjects | List | Top risk objects in a time period |
topHitPolicies | List | Top hit policies in a time period |
topRiskEventType | List | Top risk event type in a time period |
topRiskPositions | List | Top risk positions in a time period |
topActivityPositions | List | Top activity positions in a time period |
alertTrend | List | The trend of alert in a time period |
usageTrend | List | The trend of usage in a time period |
riskSeverity | List | The risk severity statistics |
name | String | Position of the alert |
id | String | Corresponding ID number of the event, policy, risk user, risk object, risk position |
key | String | The event name, risk user name, policy name, activity name, alert name, risk object name, trend time |
value | long | The number of the statics items |
Sample Response
{
"topRiskUsers":[
{
"id":"0050P000006k18GQAQ",
"key":"yue zhang",
"value":2
}
],
"topRiskObjects":[
{
"id":"0690P000006mwkbQAA",
"key":"SSN2020-03-11T17:00:24.746Z.txt",
"value":4
},
{
"id":"0690P000006mwlPQAQ",
"key":"CA_Driver2020-03-11T17:00:30.133Z.txt",
"value":4
},
{
"id":"0690P000006mwloQAA",
"key":"CN_Passport2020-03-11T17:00:32.464Z.txt",
"value":4
},
{
"id":"0690P000006mwkgQAA",
"key":"CNID2020-03-11T17:00:25.632Z.txt",
"value":3
},
{
"id":"0690P000006mwlUQAQ",
"key":"CN_Driver2020-03-11T17:00:30.566Z.txt",
"value":3
}
],
"topHitPolicies":[
{
"id":"16615",
"key":"Restricted User",
"value":35
},
{
"id":"16598",
"key":"DLP UK Passport Number Policy",
"value":4
},
{
"id":"16601",
"key":"DLP USA/Germany Passport Number Policy",
"value":4
},
{
"id":"16599",
"key":"DLP AU Passport Number Policy",
"value":3
},
{
"id":"16603",
"key":"DLP CA Driver License Policy",
"value":3
}
],
"topRiskEventType":[
{
"id":"202",
"key":"Upload File",
"value":76
},
{
"id":"238",
"key":"Post",
"value":4
},
{
"id":"214",
"key":"Login Success",
"value":2
},
{
"id":"239",
"key":"Comment",
"value":1
}
],
"topRiskPositions":[
{
"name":"United States of America",
"key":"US",
"value":83
}
],
"topActivityPositions":[
{
"name":"United States of America",
"key":"US",
"value":35
}
],
"alertTrend":[
{
"id":"0",
"key":"2020-03-10T21:00:00+0000",
"value":0
}
],
"usageTrend":[
{
"id":"0",
"key":"2020-03-10T21:00:00+0000",
"value":0
}
],
"riskSeverity":[
{
"id":"0",
"key":"Alert",
"value":82
},
{
"id":"1",
"key":"Critical",
"value":1
}
]
}