Get Dashboard/Widget value from Cortex XSOAR

ce13 — Wed, 21 Sep 2022 03:22:33 GMT

I created API key in setting and trying to get the dashboard/widget value (e.g. Playbook runs) from XSOAR but failed.

In the API guideline, there is no example of body parameters in "Get Dashboard Statistics" or "Get Widget Statistics", so I have no idea what should I input in order to get the value. Would someone please help for this? Thanks.

Re: Get Dashboard/Widget value from Cortex XSOAR

tyler_bailey — Wed, 21 Sep 2022 12:36:07 GMT

The parameter to the "Get Widget Statistics" API is a JSON object representing the widget. This object can be downloaded from the XSOAR GUI. When you are editing your widget there is a button at the bottom to download the widget as JSON.

This JSON file can then be used as the data to a POST request to /v2/statistics/widgets/query.

An example widget JSON object:

{ "id": "03b886ce-b254-4c70-8630-74231edf1170", "version": 1, "cacheVersn": 0, "modified": "2022-05-31T12:49:27.330990346Z", "packID": "", "packName": "", "itemVersion": "", "fromServerVersion": "", "toServerVersion": "", "propagationLabels": [ "all" ], "definitionId": "", "vcShouldIgnore": false, "vcShouldKeepItemLegacyProdMachine": false, "commitMessage": "", "shouldCommit": false, "Cache": null, "name": "Rate Limited API Calls", "prevName": "Rate Limited API Calls", "dataType": "metrics", "widgetType": "number", "query": "type:integration and apiResponseType:QuotaError", "isPredefined": false, "dateRange": { "fromDate": "0001-01-01T00:00:00Z", "toDate": "0001-01-01T00:00:00Z", "period": { "by": "", "byTo": "", "byFrom": "days", "toValue": null, "fromValue": 7, "field": "" }, "fromDateLicense": "0001-01-01T00:00:00Z" }, "params": { "keys": [ "sum|totalAPICalls" ], "valuesFormat": "abbreviated" }, "category": "" }

Using that JSON object to query the API:

$ curl -k -X POST https://xsoar.local/v2/statistics/widgets/query --header "Authorization:<APIKEY>" --header "Content-Type:application/json" -d @widget.json 0

Hopefully that helps!

Re: Get Dashboard/Widget value from Cortex XSOAR

ce13 — Thu, 22 Sep 2022 01:19:50 GMT

Thanks. I am able to get the value through API query.

topic Re: Get Dashboard/Widget value from Cortex XSOAR in Cortex XSOAR Discussions

Get Dashboard/Widget value from Cortex XSOAR

Re: Get Dashboard/Widget value from Cortex XSOAR

Re: Get Dashboard/Widget value from Cortex XSOAR