Obtenez Advanced Analytics données - Netskope Documentation technique

Ces points de terminaison renvoient les résultats des rapports et des widgets Advanced Analytics spécifiques à la bibliothèque personnelle, de groupe ou Netskope.

Le jeton doit être transmis à chaque appel à l'API REST pour le locataire. Nous vous recommandons de placer le jeton dans le corps de la demande, et non dans l'URL du point final.

Tous les rapports Demande de point final

https://<tenant-URL>/api/v1/all_reports

Ce point d'accès renvoie des informations sur les rapports pour le compte et des informations connexes comme suit :

{
  "report_id": "5",
  "report_name": "MallaTestDashboard",
  "folder_id": "88",
  "folder_name": "old",
  "folder_type": "shared"
}

L'objectif de l'API "all_reports" est d'obtenir le site Report Name, Report ID, and Folder ID pour un compte et d'utiliser ces informations pour les transmettre aux API suivantes :

https://<tenant-URL>/api/v1/widgets_in_report

https://<tenant-URL>/api/v1/report_widget_data

Response

Exemple d'URL : https://<tenant-URL>/api/v1/all_reports?

Exemple de sortie :

{
    "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
        }
    ]
}

Widgets dans un point final de demande de rapport

https://<tenant-URL>/api/v1/widgets_in_report

Ce point d'accès renvoie tous les widgets présents dans un rapport. Il comprend les éléments suivants :

Informations sur le rapport
Nombre de widgets
Informations sur les widgets

Clé	Value	Description
jeton	string	Le jeton obtenu sur la page de l'API REST dans l'interface utilisateur de Netskope ( Settings > Tools > Rest API v1) est nécessaire. Nous vous recommandons de placer le jeton dans le corps de la demande, et non dans l'URL du point final.
report_id	nombre entier positif	L'identifiant du rapport est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/all_reports`Si report_id est transmis, folder_id n'est pas obligatoire.
report_name	Chaîne de caractères encodée dans l'URL	Le nom du rapport est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/all_reports`Si report_name est adopté, folder_id est obligatoire.
folder_id	nombre entier positif	L'identifiant de dossier d'un rapport est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/all_reports`

L'identifiant du rapport (report_id) ou le nom du rapport (report_name) doivent être présents.

Response

Exemples d'URL :

(uniquement l'identifiant du rapport)

https://<tenant-URL>/api/v1/widgets_in_report?report_id=4829

(nom_du_rapport avec nom_du_dossier)

https://<tenant-URL>/api/v1/widgets_in_report?folder_id=311&report_name=Web%20Exec%20Dashboard%20Personal

Exemple de sortie :

{
    "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"
            }
        ]
    }
}

Point d'arrivée de la demande de données du widget de rapport

https://<tenant-URL>/api/v1/report_widget_data

Ce point d'accès renvoie les informations relatives à un widget présent dans un rapport au format CSV et JSON. La limite de lignes dans les données renvoyées est de 10000.

Clé	Value	Description
jeton	string	Le jeton obtenu sur la page de l'API REST dans l'interface utilisateur de Netskope ( Settings > Tools > Rest API v1) est nécessaire. Nous vous recommandons de placer le jeton dans le corps de la demande, et non dans l'URL du point final.
report_id	nombre entier positif	L'identifiant du rapport est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/widgets_in_report`Si report_id est transmis, folder_id n'est pas obligatoire.
report_name	Chaîne de caractères encodée dans l'URL	Le nom du rapport est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/widgets_in_report`Si report_name est adopté, folder_id est obligatoire.
widget_id	nombre entier positif	Le widget_id est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/widgets_in_report`
widget_name	Chaîne de caractères encodée dans l'URL	Le nom du widget est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/widgets_in_report`
folder_id	nombre entier positif	L'identifiant de dossier d'un rapport est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/widgets_in_report`
result_format	csv \| json	result format (default: csv)

L'identifiant du rapport (report_id) ou le nom du rapport (report_name) doivent être présents.

Le widget_id ou le widget_name doit être présent.

Response

Exemples d'URL :

(report_id seulement avec widget_id)

https://<tenant-URL>/api/v1/report_widget_data?report_id=4829&widget_id=29472

(report_id seulement avec widget_name)

https://<tenant-URL>/api/v1/report_widget_data?report_id=4829&widget_name=Alerts%20-%20%23Events_ChangePrevPeriod

(nom_du_rapport avec nom_du_dossier et nom_du_widget)

https://<tenant-URL>/api/v1/report_widget_data?report_name=Web%20Exec%20Dashboard%20Personal&widget_id=29472

(nom_du_rapport avec nom_du_dossier et nom_du_widget)

https://<tenant-URL>/api/v1/widgets_in_report?folder_id=311&report_name=Web%20Exec%20Dashboard%20Personal

Exemple de sortie :

Álerts # Events,Diff_Prev_Period
,
"1,546",-28%
"2,138",

Point de terminaison de la demande de tous les widgets

https://<tenant-URL>/api/v1/all_widgets

Ce point d'accès renvoie des informations sur les rapports pour le compte et des informations connexes comme suit :

Exemple de sortie :

{
  "widget_id": 11,
  "widget_name": "AE_AppCategoryCounts",
  "folder_id": "88",
  "folder_name": "old",
  "folder_type": "shared"
}

L'objectif de l'API "all_widgets" est d'obtenir le nom du widget, l'ID du widget et l'ID du dossier et de les transmettre à l'API suivante :

https://<tenant-URL>/api/v1/widget_data

Response

Exemple d'URL :

https://<tenant-URL>/api/v1/all_widgets

Exemple de sortie :

{
    "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
        }
    ]
}

Point d'arrivée de la demande de données du widget

https://<tenant-URL>/api/v1/widget_data

Ce point d'accès renvoie les informations relatives à un widget au format CSV et JSON. La limite de lignes dans les données renvoyées est de 10000.

Clé	Value	Description
jeton	string	Le jeton obtenu sur la page de l'API REST dans l'interface utilisateur de Netskope ( Settings > Tools > Rest API v1) est nécessaire. Nous vous recommandons de placer le jeton dans le corps de la demande, et non dans l'URL du point final.
widget_id	nombre entier positif	Le widget_id est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/all_widgets`
widget_name	Chaîne de caractères encodée dans l'URL	Le nom du widget est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/all_widgets`
folder_id	nombre entier positif	L'identifiant de dossier d'un rapport est dérivé de l'API suivante : `https://<tenant-URL>/api/v1/all_widgets`
result_format	csv \| json	result format (default: csv)

Le widget_id ou le widget_name doit être présent.

Response

Exemples d'URL :

(widget_id uniquement)

https://<tenant-URL>/api/v1/widget_data?widget_id=358

(nom_du_widget avec nom_du_dossier)

https://<tenant-URL>/api/v1/widget_data?folder_id=18&;widget_name=User%20Country%20to%20Application%20to%20Destination%20Country

Exemple de sortie :

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"

Limite de 50 secondes pour le délai d'attente du backend

Veuillez noter que there’s no guarantee for the data processing time. Plus vous demandez de données, plus le temps de traitement des données peut être long. L'API RESTful d'Advanced Analytics est soumise à une limite de temps stricte de 50 secondes. Toute erreur de délai découlant de demandes qui dépassent ce seuil en raison d'un volume de données excessif ne relève pas du champ d'application de l'assistance d'Advanced Analytics.