Get Widget Statistics

Cortex XSOAR 6 API

post /v2/statistics/widgets/query

Get the statistics for the specified widget. Note: This endpoint has many return types depending on the widget type and data. Each 200X represents a 200 OK request of specific widget type and data.

CURL
curl -X POST \ -H "Authorization: [[apiKey]]" \ -H "Accept: application/json" \ -H "Content-Type: application/json,application/xml" \ "https://hostname:443/v2/statistics/widgets/query" \ -d '{ "dateRange" : { "fromDate" : "fromDate", "toDate" : "toDate" }, "dataType" : "dataType", "query" : "query", "name" : "name", "id" : "id", "params" : { "groupBy" : [ "groupBy", "groupBy" ] }, "category" : "category", "widgetType" : "widgetType" }' \ -d ' aeiou aeiou aeiou aeiou aeiou aeiou aeiou aeiou aeiou '
Authentication: api_key Api Key "Authorization"
Request
Body
optional
id
optional
String
name
optional
String
dataType
optional
String
widgetType
optional
String
query
optional
String
dateRange
optional
fromDate
optional
String
toDate
optional
String
params
optional
groupBy
optional
Array of strings
category
optional
String
Responses

Response differ according to the widget type

  • Incident data type of a "table" or "list" widget returns incidentSearchResponse total: type: integer data: type: array items: "$ref": "#/definitions/Incident" - Indicators data type of a "table" or "list" widget returns IoCsResponse total: type: integer data: type: array items: "$ref": "#/definitions/IocObject" - Number widget returns a simple number type: integer - Trend widget returns a trend object "$ref": "#/definitions/StatsTrendsResponse" - Text widget returns a text object, describing the final text and the placeholders values. "$ref": "#/definitions/StatsTextResponse" - Line chart widget or Column chart widget returns StatsResponseWithReferenceLine "$ref": "#/definitions/StatsResponseWithReferenceLine" - A chart data array by groups. When requesting a date, the key is the date string, according to the specified time frame. Empty groups (dates) are also returned. type: array items: "$ref": "#/definitions/Group"
Body