Dashboards

APIs for managing dashboards

Import a dashboard

post

Import a dashboard to Cortex XSOAR

Authorizations

AuthorizationstringRequired

Body

filestringOptional

The JSON file of the dashboard to import.

Responses

200

The saved dashboard

application/json

allReadbooleanOptional

allReadWritebooleanOptional

cacheVersninteger · int64Optional

commitMessagestringOptional

createdstring · date-timeOptional

dbotCreatedBystringOptional

Who has created this event - relevant only for manual incidents

definitionIdstringOptional

fromDatestring · date-timeOptional

fromDateLicensestring · date-timeOptional

hasRolebooleanOptional

Internal field to make queries on role faster

hidePivotbooleanOptional

hideSearchbooleanOptional

idstringOptional

indexNamestringOptional

isCommonbooleanOptional

lockedbooleanOptional

modifiedstring · date-timeOptional

modulePagebooleanOptional

namestringOptional

numericIdinteger · int64Optional

ownerstringOptional

packIDstringOptional

packNamestringOptional

packPropagationLabelsstring[]Optional

prevNamestringOptional

previousAllReadbooleanOptional

previousAllReadWritebooleanOptional

previousRolesstring[]Optional

Do not change this field manually

primaryTerminteger · int64Optional

propagationLabelsstring[]Optional

remotebooleanOptional

rolesstring[]Optional

The role assigned to this investigation

sequenceNumberinteger · int64Optional

shouldCommitbooleanOptional

sizeInBytesinteger · int64Optional

sortValuesstring[]Optional

syncHashstringOptional

systembooleanOptional

toDatestring · date-timeOptional

vcShouldIgnorebooleanOptional

vcShouldKeepItemLegacyProdMachinebooleanOptional

versioninteger · int64Optional

xsoarHasReadOnlyRolebooleanOptional

xsoarPreviousReadOnlyRolesstring[]Optional

xsoarReadOnlyRolesstring[]Optional

post/dashboards/import

POST /dashboards/import HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "file": "text"
}

200

The saved dashboard

{
  "accounts": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "allRead": true,
  "allReadWrite": true,
  "cacheVersn": 1,
  "commitMessage": "text",
  "created": "2026-01-01T00:00:00.000Z",
  "dbotCreatedBy": "text",
  "definitionId": "text",
  "fromDate": "2026-01-01T00:00:00.000Z",
  "fromDateLicense": "2026-01-01T00:00:00.000Z",
  "fromServerVersion": {
    "Digits": [
      1
    ],
    "Label": "text"
  },
  "hasRole": true,
  "hidePivot": true,
  "hideSearch": true,
  "highlight": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "id": "text",
  "indexName": "text",
  "isCommon": true,
  "itemVersion": {
    "Digits": [
      1
    ],
    "Label": "text"
  },
  "layout": [
    {
      "forceRange": true,
      "h": 1,
      "i": "text",
      "id": "text",
      "reflectDimensions": true,
      "w": 1,
      "widget": {
        "Cache": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "accounts": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "cacheVersn": 1,
        "category": "text",
        "commitMessage": "text",
        "created": "2026-01-01T00:00:00.000Z",
        "dataType": "text",
        "dateRange": {
          "fromDate": "2026-01-01T00:00:00.000Z",
          "fromDateLicense": "2026-01-01T00:00:00.000Z",
          "period": {
            "by": "text",
            "byFrom": "text",
            "byTo": "text",
            "field": "text",
            "fromValue": "text",
            "toValue": "text"
          },
          "toDate": "2026-01-01T00:00:00.000Z"
        },
        "definition": {
          "auditable": true,
          "cacheVersn": 1,
          "commitMessage": "text",
          "created": "2026-01-01T00:00:00.000Z",
          "definitionId": "text",
          "fromServerVersion": {
            "Digits": [
              1
            ],
            "Label": "text"
          },
          "highlight": {
            "ANY_ADDITIONAL_PROPERTY": [
              "text"
            ]
          },
          "id": "text",
          "indexName": "text",
          "itemVersion": {
            "Digits": [
              1
            ],
            "Label": "text"
          },
          "locked": true,
          "modified": "2026-01-01T00:00:00.000Z",
          "name": "text",
          "numericId": 1,
          "packID": "text",
          "packName": "text",
          "packPropagationLabels": [
            "text"
          ],
          "partitioned": true,
          "pluralName": "text",
          "prevName": "text",
          "primaryTerm": 1,
          "propagationLabels": [
            "text"
          ],
          "rbacSupport": true,
          "remote": true,
          "sequenceNumber": 1,
          "shouldCommit": true,
          "sizeInBytes": 1,
          "sortValues": [
            "text"
          ],
          "syncHash": "text",
          "system": true,
          "toServerVersion": {
            "Digits": [
              1
            ],
            "Label": "text"
          },
          "vcShouldIgnore": true,
          "vcShouldKeepItemLegacyProdMachine": true,
          "version": 1
        },
        "definitionId": "text",
        "description": "text",
        "fromServerVersion": {
          "Digits": [
            1
          ],
          "Label": "text"
        },
        "highlight": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "id": "text",
        "ignoreWorkers": true,
        "indexName": "text",
        "isPredefined": true,
        "itemVersion": {
          "Digits": [
            1
          ],
          "Label": "text"
        },
        "locked": true,
        "modified": "2026-01-01T00:00:00.000Z",
        "name": "text",
        "numericId": 1,
        "packID": "text",
        "packName": "text",
        "packPropagationLabels": [
          "text"
        ],
        "page": 1,
        "params": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "prevName": "text",
        "primaryTerm": 1,
        "propagationLabels": [
          "text"
        ],
        "query": "text",
        "remote": true,
        "searchAfter": [
          "text"
        ],
        "searchAfterElastic": [
          "text"
        ],
        "searchAfterMap": {
          "ANY_ADDITIONAL_PROPERTY": [
            "text"
          ]
        },
        "searchAfterMapOrder": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "searchBefore": [
          "text"
        ],
        "searchBeforeElastic": [
          "text"
        ],
        "sequenceNumber": 1,
        "shouldCommit": true,
        "size": 1,
        "sizeInBytes": 1,
        "skipAggregateAccounts": true,
        "sort": [
          {
            "asc": true,
            "field": "text",
            "fieldType": "text"
          }
        ],
        "sortValues": [
          "text"
        ],
        "syncHash": "text",
        "toServerVersion": {
          "Digits": [
            1
          ],
          "Label": "text"
        },
        "vcShouldIgnore": true,
        "vcShouldKeepItemLegacyProdMachine": true,
        "version": 1,
        "widgetType": "text"
      },
      "x": 1,
      "y": 1
    }
  ],
  "locked": true,
  "modified": "2026-01-01T00:00:00.000Z",
  "modulePage": true,
  "name": "text",
  "numericId": 1,
  "owner": "text",
  "packID": "text",
  "packName": "text",
  "packPropagationLabels": [
    "text"
  ],
  "period": {
    "by": "text",
    "byFrom": "text",
    "byTo": "text",
    "field": "text",
    "fromValue": "text",
    "toValue": "text"
  },
  "prevName": "text",
  "previousAllRead": true,
  "previousAllReadWrite": true,
  "previousRoles": [
    "text"
  ],
  "primaryTerm": 1,
  "propagationLabels": [
    "text"
  ],
  "remote": true,
  "roles": [
    "text"
  ],
  "sequenceNumber": 1,
  "shouldCommit": true,
  "sizeInBytes": 1,
  "sortValues": [
    "text"
  ],
  "syncHash": "text",
  "system": true,
  "toDate": "2026-01-01T00:00:00.000Z",
  "toServerVersion": {
    "Digits": [
      1
    ],
    "Label": "text"
  },
  "vcShouldIgnore": true,
  "vcShouldKeepItemLegacyProdMachine": true,
  "version": 1,
  "xsoarHasReadOnlyRole": true,
  "xsoarPreviousReadOnlyRoles": [
    "text"
  ],
  "xsoarReadOnlyRoles": [
    "text"
  ]
}

[Deprecated] Get Dashboard Statistics

post

Get a given dashboard statistics result. Deprecated - use "/v2/statistics/dashboards/query

Authorizations

AuthorizationstringRequired

Responses

200

Return an array of stats results for each widget cell in dashboard.

application/json

accountErrorsstring[]Optional

dataobjectOptional

data array or object describing the statistics data based on type.

totalAccountsinteger · int64Optional

widgetCellIdstringOptional

post/statistics/dashboards/query

POST /statistics/dashboards/query HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*

200

Return an array of stats results for each widget cell in dashboard.

[
  {
    "accountErrors": [
      "text"
    ],
    "data": {},
    "totalAccounts": 1,
    "widgetCellId": "text"
  }
]

Get Dashboard Statistics

post

Get a given dashboard statistics result.

Authorizations

AuthorizationstringRequired

Responses

200

Return an array of stats results for each widget cell in dashboard.

application/json

accountErrorsstring[]Optional

dataobjectOptional

data array or object describing the statistics data based on type.

totalAccountsinteger · int64Optional

widgetCellIdstringOptional

post/v2/statistics/dashboards/query

POST /v2/statistics/dashboards/query HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*

200

Return an array of stats results for each widget cell in dashboard.

[
  {
    "accountErrors": [
      "text"
    ],
    "data": {},
    "totalAccounts": 1,
    "widgetCellId": "text"
  }
]