Ctrlk
BlogSupport
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Widgets

APIs for managing widgets

Get widget statistics

post

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.

Header parameters
authorizationstringRequired

api_key

Example: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-idstringRequired

api_key_id

Example: 2841
Body
idstringOptional
namestringOptional
dataTypestringOptional
widgetTypestringOptional
querystringOptional
categorystringOptional
Responses
200

Response depends on the widget type:

  • Incident data type of a "table" or "list" widget returns incidentSearchResponse total: type: integer data: type: array items: "$ref": "#/components/schemas/Incident"
  • Indicators data type of a "table" or "list" widget returns IoCsResponse total: type: integer data: type: array items: "$ref": "#/components/schemas/IocObject"
  • Number widget returns a simple number type: integer
  • Trend widget returns a trend object "$ref": "#/components/schemas/StatsTrendsResponse"
  • Text widget returns a text object, describing the final text and the placeholders values. "$ref": "#/components/schemas/StatsTextResponse"
  • Line chart widget or Column chart widget returns StatsResponseWithReferenceLine "$ref": "#/components/schemas/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": "#/components/schemas/Group"
application/json
or
or
or
or
or
or
post/xsoar/public/v2/statistics/widgets/query
POST /xsoar/public/v2/statistics/widgets/query HTTP/1.1
Host: api-yourfqdn
authorization: DCdIeow0xm73EwnxjPza1tdHTfZQv2eH7bTKlTPkgBHLj8aSjFzjgTE9bQUK1DidlWLrnYRhaYQ4PCIyNrNJbMUC6DOWi8ANIn1JWpMTE2neGvoDIRsKUbj6pJ1z7Gmr
x-xdr-auth-id: 2841
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "script": {
    "name": "hello_world_2",
    "dockerImage": "demisto/python3:3.10.14.92207",
    "propagationLabels": [
      "all"
    ]
  },
  "savePassword": false
}
200

Response depends on the widget type:

  • Incident data type of a "table" or "list" widget returns incidentSearchResponse total: type: integer data: type: array items: "$ref": "#/components/schemas/Incident"
  • Indicators data type of a "table" or "list" widget returns IoCsResponse total: type: integer data: type: array items: "$ref": "#/components/schemas/IocObject"
  • Number widget returns a simple number type: integer
  • Trend widget returns a trend object "$ref": "#/components/schemas/StatsTrendsResponse"
  • Text widget returns a text object, describing the final text and the placeholders values. "$ref": "#/components/schemas/StatsTextResponse"
  • Line chart widget or Column chart widget returns StatsResponseWithReferenceLine "$ref": "#/components/schemas/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": "#/components/schemas/Group"
{
  "ErrorsPrivateDoNotUse": null,
  "total": 1,
  "data": [
    {
      "id": "178794",
      "version": 1,
      "cacheVersn": 0,
      "modified": "2024-04-30T13:02:17.93Z",
      "sizeInBytes": 0,
      "sortValues": [
        "1"
      ],
      "dbotCreatedBy": "user@company.com",
      "CustomFields": {
        "bmcassignee": [
          {}
        ],
        "bmccustomer": [
          {}
        ],
        "bmcrequester": [
          {}
        ],
        "containmentsla": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 30,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "crowdstrikefalconbehaviourpatterndispositiondetails": [
          {},
          {},
          {}
        ],
        "datadogcloudsiem": [
          {},
          {},
          {}
        ],
        "dataminrpulserelatedterms": [
          {},
          {},
          {}
        ],
        "decyfirdatadetails": [
          {},
          {},
          {}
        ],
        "detectionsla": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 20,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "domaintoolsirisdetect": [
          {},
          {},
          {}
        ],
        "endpoint": [
          {}
        ],
        "externalid": "178794",
        "extrahoprevealxdetectiondevices": [
          {},
          {},
          {}
        ],
        "extrahoprevealxmitretechniques": [
          {},
          {},
          {}
        ],
        "filerelationships": [
          {},
          {},
          {}
        ],
        "fortisiemattacktactics": [
          {},
          {}
        ],
        "fortisiemevents": [
          {}
        ],
        "incidentduration": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 0,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "incidentrdpachehuntingstringssimilarity": [
          {},
          {},
          {}
        ],
        "incidentrdpcachehuntingstringsifter": [
          {},
          {},
          {}
        ],
        "inventasource": [
          {}
        ],
        "microsoftsentinelowner": [],
        "qintelqwatchexposures": [
          {},
          {},
          {}
        ],
        "remediationsla": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 7200,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "3degpevt": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "3rxb5har": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "42q8ri0w": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "7prumt0z": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "a28fg0oj": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "bmhsqopn": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "bxvy7aci": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "bzxrevrq": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "cfzmni5r": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "h5eoo5d7": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "irh1zn5e": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "iuoszzbg": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "jbpbuedw": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "kethuvyk": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "lyefflpk": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "o4zg2bva": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "oq4ib3rq": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "oupkddj1": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "psjrp4kv": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "pufesh2i": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "qub0kxf8": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "sbwfoqdv": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "tzpheljw": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "v86tnqon": [
          {}
        ],
        "wl53df56": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "xtmm8ix9": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "ym2kvwjh": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 1,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "rsametasevents": [],
        "rsarawlogslist": [],
        "securitypolicymatch": [
          {}
        ],
        "similarincidentsdbot": [
          {}
        ],
        "spycloudcompassdevicedata": [
          {},
          {},
          {}
        ],
        "suspiciousexecutions": [
          {},
          {},
          {}
        ],
        "timetoassignment": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 0,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "triagesla": {
          "accumulatedPause": 0,
          "breachTriggered": false,
          "dueDate": "0001-01-01T00:00:00Z",
          "endDate": "0001-01-01T00:00:00Z",
          "lastPauseDate": "0001-01-01T00:00:00Z",
          "runStatus": "idle",
          "sla": 30,
          "slaStatus": -1,
          "startDate": "0001-01-01T00:00:00Z",
          "totalDuration": 0
        },
        "urlsslverification": [],
        "xdralertsearchresults": [
          {},
          {},
          {}
        ],
        "xdrinvestigationresults": [
          {},
          {},
          {},
          {
            "columnheader1": ""
          },
          {},
          {
            "columnheader1": ""
          },
          {},
          {}
        ],
        "xpanseserviceclassifications": [
          {},
          {},
          {}
        ],
        "xpanseservicevalidation": [
          {
            "columnheader1": ""
          },
          {},
          {}
        ]
      },
      "account": "",
      "autime": 1714482136614000000,
      "type": "default_type",
      "rawType": "default_type",
      "name": "ITmoiUOu",
      "rawName": "ITmoiUOu",
      "status": 1,
      "custom_status": "",
      "resolution_status": "",
      "reason": "",
      "created": "2024-04-30T13:02:16.614Z",
      "occurred": "2024-04-30T13:02:16.929227958Z",
      "closed": "0001-01-01T00:00:00Z",
      "sla": 0,
      "severity": 1,
      "investigationId": "178794",
      "labels": [
        {
          "value": "user@company.com",
          "type": "Instance"
        },
        {
          "value": "Manual",
          "type": "Brand"
        }
      ],
      "attachment": null,
      "details": "",
      "openDuration": 0,
      "lastOpen": "0001-01-01T00:00:00Z",
      "closingUserId": "",
      "owner": "",
      "activated": "0001-01-01T00:00:00Z",
      "closeReason": "",
      "rawCloseReason": "",
      "closeNotes": "",
      "playbookId": "",
      "dueDate": "0001-01-01T00:00:00Z",
      "reminder": "0001-01-01T00:00:00Z",
      "runStatus": "",
      "notifyTime": "0001-01-01T00:00:00Z",
      "phase": "",
      "rawPhase": "",
      "isPlayground": false,
      "rawJSON": "",
      "parent": "",
      "parentXDRIncident": "",
      "retained": false,
      "category": "",
      "rawCategory": "",
      "linkedIncidents": [],
      "linkedCount": 0,
      "droppedCount": 0,
      "sourceInstance": "user@company.com",
      "sourceBrand": "Manual",
      "canvases": null,
      "lastJobRunTime": "0001-01-01T00:00:00Z",
      "feedBased": false,
      "dbotMirrorId": "",
      "dbotMirrorInstance": "",
      "dbotMirrorDirection": "",
      "dbotDirtyFields": null,
      "dbotCurrentDirtyFields": null,
      "dbotMirrorTags": null,
      "dbotMirrorLastSync": "0001-01-01T00:00:00Z",
      "isDebug": false
    }
  ]
}
PreviousSystem Management
NextModels

Last updated

Was this helpful?