これらのエンドポイントは、 Advanced Analyticsレポートの結果と、個人、グループ、またはNetskopeライブラリに固有のウィジェットを返します。
テナントに対するすべてのREST API呼び出しにトークンを渡す必要があります。エンドポイント URL ではなく、リクエストの本文にトークンを配置することをお勧めします。
すべてのレポートリクエストエンドポイント
https://<tenant-URL>/api/v1/all_reports
このエンドポイントは、アカウントのレポートおよび関連情報を以下のように返します。
{
"report_id": "5",
"report_name": "MallaTestDashboard",
"folder_id": "88",
"folder_name": "old",
"folder_type": "shared"
}
「all_reports」APIの目的は、アカウントのReport Name, Report ID, and Folder IDを取得し、 この情報を以下のAPIに渡すことです。
https://<tenant-URL>/api/v1/widgets_in_report
https://<tenant-URL>/api/v1/report_widget_data
Response
サンプルURL： https://<tenant-URL>/api/v1/all_reports?
サンプル出力:
{
"status": "success",
"msg": "",
"data": [
{
"report_id": 4692,
"report_name": "Ved Group Report 3",
"folder_id": 291,
"folder_name": "Personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 158
},
{
"report_id": 4721,
"report_name": "Cloud Risk Assessment Copy 3",
"folder_id": 40,
"folder_name": "developer.vbox",
"folder_type": "group",
"user": "developer@netskope.com",
"user_id": 158
},
{
"report_id": 4738,
"report_name": "Cloud Risk Assessment REST",
"folder_id": 311,
"folder_name": "Personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 171
},
{
"report_id": 4739,
"report_name": "Cloud Risk Assessment Group",
"folder_id": 40,
"folder_name": "developer.vbox",
"folder_type": "group",
"user": "developer@netskope.com",
"user_id": 171
},
{
"report_id": 4820,
"report_name": "sub personal",
"folder_id": 428,
"folder_name": "sub personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 171
},
{
"report_id": 4821,
"report_name": "sub personal Copy",
"folder_id": 311,
"folder_name": "Personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 171
},
{
"report_id": 4822,
"report_name": "sub group",
"folder_id": 404,
"folder_name": "sub group 1",
"folder_type": "group",
"user": "developer@netskope.com",
"user_id": 171
},
{
"report_id": 4823,
"report_name": "group",
"folder_id": 40,
"folder_name": "developer.vbox",
"folder_type": "group",
"user": "developer@netskope.com",
"user_id": 171
},
{
"report_id": 4829,
"report_name": "Web Exec Dashboard Personal",
"folder_id": 311,
"folder_name": "Personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 171
}
]
}
レポートリクエストエンドポイント内のウィジェット
https://<tenant-URL>/api/v1/widgets_in_report
このエンドポイントは、レポート内に存在するすべてのウィジェットを返します。これには以下のものが含まれます。
- レポート情報
- ウィジェットの数
- ウィジェット情報
| 鍵 | Value | デスクリプション |
|---|---|---|
| トークン | string | Netskope UI の REST API ページ ( Settings > Tools > Rest API v1 ) から取得したトークンが必要です。エンドポイント URL ではなく、リクエストの本文にトークンを配置することをお勧めします。 |
| report_id | 正の整数 | report_id は以下の API から取得されます。
|
| report_name | URLエンコードされた文字列 | report_name は、以下の API から取得されます。
|
| folder_id | 正の整数 | レポートのfolder_idは、以下のAPIから取得されます。
|
report_idまたはreport_nameのいずれかが存在する必要があります。
Response
サンプルURL：
(レポートIDのみ)
https://<tenant-URL>/api/v1/widgets_in_report?report_id=4829
(レポート名とフォルダID)
https://<tenant-URL>/api/v1/widgets_in_report?folder_id=311&report_name=Web%20Exec%20Dashboard%20Personal
サンプル出力:
{
"status": "success",
"msg": "",
"data": {
"report": {
"report_name": "Web Exec Dashboard Personal",
"report_id": "4829",
"folder": "Personal: developer@netskope.com",
"folder_id": "311"
},
"widget_count": 8,
"widgets": [
{
"widget_name": "Alerts - #Anomalies_ChangePrevPeriod",
"widget_id": "29468",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "query"
},
{
"widget_name": "Alerts - #PolicyAlerts_ChangePrevPeriod",
"widget_id": "29469",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "query"
},
{
"widget_name": "Top Site Categories by Bytes",
"widget_id": "29470",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "query"
},
{
"widget_name": "Top Sites by Bytes",
"widget_id": "29471",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "query"
},
{
"widget_name": "Alerts - #Events_ChangePrevPeriod",
"widget_id": "29472",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "query"
},
{
"widget_name": "% of Sites Allowed/Blocked For Blocked Categories",
"widget_id": "29473",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "merge_query",
"info": "Can not be used for CSV export."
},
{
"widget_name": "Alerts - #MalaciousAlerts_ChangePrevPeriod",
"widget_id": "29474",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "query"
},
{
"widget_name": "#Malicious Sites by Category",
"widget_id": "29475",
"folder": "Personal: developer@netskope.com",
"folder_id": "311",
"type": "query"
}
]
}
}
レポートウィジェットデータリクエストエンドポイント
https://<tenant-URL>/api/v1/report_widget_data
このエンドポイントは、レポート内に存在するウィジェットの情報をCSVおよびJSON形式で返します。返されるデータの行数の上限は10000です。
| 鍵 | Value | デスクリプション |
|---|---|---|
| トークン | string | Netskope UI の REST API ページ ( Settings > Tools > Rest API v1 ) から取得したトークンが必要です。エンドポイント URL ではなく、リクエストの本文にトークンを配置することをお勧めします。 |
| report_id | 正の整数 | report_id は以下の API から取得されます。
|
| report_name | URLエンコードされた文字列 | report_name は、以下の API から取得されます。
|
| widget_id | 正の整数 | widget_id は、以下の API から取得されます。
|
| widget_name | URLエンコードされた文字列 | widget_name は、以下の API から取得されます。
|
| folder_id | 正の整数 | レポートのfolder_idは、以下のAPIから取得されます。
|
| result_format | csv | json | result format (default: csv) |
report_idまたはreport_nameのいずれかが存在する必要があります。
widget_id または widget_name のいずれかを指定する必要があります。
Response
サンプルURL：
(report_id は widget_id とのみ関連付けられます)
https://<tenant-URL>/api/v1/report_widget_data?report_id=4829&widget_id=29472
(report_id と widget_name のみ)
https://<tenant-URL>/api/v1/report_widget_data?report_id=4829&widget_name=Alerts%20-%20%23Events_ChangePrevPeriod
(レポート名、フォルダID、ウィジェットIDを含む)
https://<tenant-URL>/api/v1/report_widget_data?report_name=Web%20Exec%20Dashboard%20Personal&widget_id=29472
(レポート名、フォルダID、ウィジェット名を含む)
https://<tenant-URL>/api/v1/widgets_in_report?folder_id=311&report_name=Web%20Exec%20Dashboard%20Personal
サンプル出力:
Álerts # Events,Diff_Prev_Period , "1,546",-28% "2,138",
すべてのウィジェットのリクエストエンドポイント
https://<tenant-URL>/api/v1/all_widgets
このエンドポイントは、アカウントのレポートおよび関連情報を以下のように返します。
サンプル出力:
{
"widget_id": 11,
"widget_name": "AE_AppCategoryCounts",
"folder_id": "88",
"folder_name": "old",
"folder_type": "shared"
}
「all_widgets」APIの目的は、ウィジェット名、ウィジェットID、およびフォルダIDを取得し、それを次のAPIに渡すことです。
https://<tenant-URL>/api/v1/widget_data
Response
サンプルURL：
https://<tenant-URL>/api/v1/all_widgets
サンプル出力:
{
"status": "success",
"msg": "",
"data": [
{
"widget_id": 480,
"widget_name": "Total Bytes 2 Copy",
"folder_id": 291,
"folder_name": "Personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 158
},
{
"widget_id": 483,
"widget_name": "test 1",
"folder_id": 291,
"folder_name": "Personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 158
},
{
"widget_id": 486,
"widget_name": "Total Bytes from Personal",
"folder_id": 40,
"folder_name": "developer.vbox",
"folder_type": "group",
"user": "developer@netskope.com",
"user_id": 158
},
{
"widget_id": 489,
"widget_name": "DLP Alerts by User Copy",
"folder_id": 417,
"folder_name": "test 5",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 158
},
{
"widget_id": 491,
"widget_name": "Total Bytes 2 Copy 1",
"folder_id": 416,
"folder_name": "test2",
"folder_type": "group",
"user": "developer@netskope.com",
"user_id": 158
},
{
"widget_id": 492,
"widget_name": "Total Bytes 2 Copy 1 Copy",
"folder_id": 407,
"folder_name": "test 3",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 158
},
{
"widget_id": 494,
"widget_name": "Users Copy",
"folder_id": 403,
"folder_name": "test 2",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 158
},
{
"widget_id": 510,
"widget_name": "Cloud Services by CCL",
"folder_id": 311,
"folder_name": "Personal",
"folder_type": "personal",
"user": "developer@netskope.com",
"user_id": 171
}
]
}
ウィジェットデータリクエストエンドポイント
https://<tenant-URL>/api/v1/widget_data
このエンドポイントは、ウィジェットに関する情報をCSV形式とJSON形式で返します。返されるデータの行数の上限は10000です。
| 鍵 | Value | デスクリプション |
|---|---|---|
| トークン | string | Netskope UI の REST API ページ ( Settings > Tools > Rest API v1 ) から取得したトークンが必要です。エンドポイント URL ではなく、リクエストの本文にトークンを配置することをお勧めします。 |
| widget_id | 正の整数 | widget_id は、以下の API から取得されます。
|
| widget_name | URLエンコードされた文字列 | widget_name は、以下の API から取得されます。
|
| folder_id | 正の整数 | レポートのfolder_idは、以下のAPIから取得されます。
|
| result_format | csv | json | result format (default: csv) |
widget_id または widget_name のいずれかが存在する必要があります。
Response
サンプルURL：
（ウィジェットIDのみ）
https://<tenant-URL>/api/v1/widget_data?widget_id=358
(ウィジェット名とフォルダID)
https://<tenant-URL>/api/v1/widget_data?folder_id=18&;widget_name=User%20Country%20to%20Application%20to%20Destination%20Country
サンプル出力:
Page Events Source Country,Page Events Application,Page Events Destination Country,Page Events Sum - Total Bytes India,Microsoft Teams,United States,"1,286,251,749" United States,Microsoft Teams,United States,"707,971,524" United States,Microsoft Office 365 OneDrive for Business,United States,"97,959,531" United Kingdom,Microsoft Teams,United States,"49,265,051" Canada,Microsoft Teams,United States,"44,885,701" United States,Microsoft Office 365 Admin,United States,"39,012,590" United States,Microsoft Office 365 Outlook.com,United States,"12,070,289" United States,Microsoft Office 365 Sharepoint Online,United States,"2,972,378" United States,Microsoft Yammer,United States,"2,586,132" India,Microsoft Office 365 Admin,United States,"2,079,168" United States,G Suite,United States,"581,583" United Kingdom,Microsoft Office 365 Outlook.com,United States,"505,919" United States,Microsoft Office 365 Suite,United States,"455,489" United States,Microsoft Office 365 Sharepoint Admin,United States,"445,634"
バックエンドタイムアウト制限：50秒
there’s no guarantee for the data processing timeにご注意ください。要求するデータ量が多いほど、データ処理に時間がかかる場合があります。Advanced Analytics RESTful APIには、50秒という厳格なタイムアウト制限が適用されます。 データ量が過剰であるためにこのしきい値を超えたリクエストから発生するタイムアウトエラーは、Advanced Analyticsのサポート範囲外となります。