Get Alert Report Summary
Description
Return all alert reports instances generated with specification on the year generated and if is generated on a monthly basis.
URL
/api/v1/report/alert/reportList
Method: Get
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 |
|
roleId |
<User ID> |
Integer |
Login user ID, can be obtained through Get Resource Map. |
| companyId | <Company ID> | Integer | Company ID of which the business unit is under, can be obtained through Get Resource Map. |
|
service |
<Salesforce> |
String |
Cloud service account |
|
year |
<Year> |
Integer |
Year the report generated. |
|
isMonthly |
<True> |
Boolean |
True if the report is monthly, false if the report is not a monthly report. |
Sample Request
|
Request URL |
GET https://www.forticasb.com/api/v1/report/alert/reportList |
| Request Header |
Authorization: Bearer <Authorization_Token> Content-Type: application/json buid: 6384 service: Salesforce companyId: 62598 roleid: 36241 isMonthly: false year: 2024 |
Response Variables
|
Name |
Type |
Description |
|---|---|---|
| name | String | Alert report name. |
| size | String | The size of the Alert report. |
| timestamp | String | Date the Alert report generated. |
Sample Response
{
"data": [
{
"name": "Salesforce_Alert_Report20240101_UTC.csv",
"size": 14108,
"timestamp": "Jan 2, 2024, 9:18:06 PM"
},
{
"name": "Salesforce_Alert_Report20240102_UTC.csv",
"size": 15990,
"timestamp": "Jan 3, 2024, 9:18:09 PM"
},
{
"name": "Salesforce_Alert_Report20240103_UTC.csv",
"size": 15116,
"timestamp": "Jan 4, 2024, 9:18:06 PM"
}
],
"code": 0,
"msg": "success",
"httpCode": 200
}