Widgets
APIs for managing widgets
Get a given widget object statistics result. Note: This route has many return types based on the widget type and data. Each 200X represent a 200 OK request of specific widget type and data
Deprecated - use "/v2/statistics/widgets/query
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" - 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"
POST /statistics/widgets/query HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
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" - 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"
{}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.
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"
POST /v2/statistics/widgets/query HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176
{
"id": "text",
"name": "text",
"dataType": "text",
"widgetType": "text",
"query": "text",
"dateRange": {
"fromDate": "text",
"toDate": "text"
},
"params": {
"groupBy": [
"text"
]
},
"category": "text"
}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"
{}Get all widgets
Return all the widgets in the system.
Widget describe a widget component used to get statistics requests, based on parameters such as dataType and widgetType. A widget can be a part of widgets collection inside a dashboard.
Category the widget is related to. Used to display in widget library under category or dataType if empty.
Data type of the widget. Describes what data does the widget query. supporting data types "incidents","messages","system","entries","tasks", "audit".
The description of the widget's usage and data representation.
Do not use workers mechanism while searching bleve
Is the widget a system widget.
Is the widget locked for editing.
Default name of the widget.
0-based page
The previous name of the widget.
Query to search on the dataType.
Efficient next page, pass max sort value from previous page
Efficient next page, pass max ES sort value from previous page
Efficient prev page, pass min sort value from next page
Efficient prev page, pass min ES sort value from next page
Size is limited to 1000, if not passed it defaults to 0, and no results will return
SkipAggregateAccounts flag that indicates whether to skip aggregate accounts results
Widget type describes how does the widget should recieve the data, and display it. Supporting types: "bar", "column", "pie", "list", "number", "trend", "text", "duration", "image", "line", and "table".
GET /widgets HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
Return all the widgets in the system.
[
{
"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"
}
]Add or update a given widget based on Id.
Widget describe a widget component used to get statistics requests, based on parameters such as dataType and widgetType. A widget can be a part of widgets collection inside a dashboard.
Category the widget is related to. Used to display in widget library under category or dataType if empty.
Data type of the widget. Describes what data does the widget query. supporting data types "incidents","messages","system","entries","tasks", "audit".
The description of the widget's usage and data representation.
Do not use workers mechanism while searching bleve
Is the widget a system widget.
Is the widget locked for editing.
Default name of the widget.
0-based page
The previous name of the widget.
Query to search on the dataType.
Efficient next page, pass max sort value from previous page
Efficient next page, pass max ES sort value from previous page
Efficient prev page, pass min sort value from next page
Efficient prev page, pass min ES sort value from next page
Size is limited to 1000, if not passed it defaults to 0, and no results will return
SkipAggregateAccounts flag that indicates whether to skip aggregate accounts results
Widget type describes how does the widget should recieve the data, and display it. Supporting types: "bar", "column", "pie", "list", "number", "trend", "text", "duration", "image", "line", and "table".
The saved widget newest version.
Widget describe a widget component used to get statistics requests, based on parameters such as dataType and widgetType. A widget can be a part of widgets collection inside a dashboard.
Category the widget is related to. Used to display in widget library under category or dataType if empty.
Data type of the widget. Describes what data does the widget query. supporting data types "incidents","messages","system","entries","tasks", "audit".
The description of the widget's usage and data representation.
Do not use workers mechanism while searching bleve
Is the widget a system widget.
Is the widget locked for editing.
Default name of the widget.
0-based page
The previous name of the widget.
Query to search on the dataType.
Efficient next page, pass max sort value from previous page
Efficient next page, pass max ES sort value from previous page
Efficient prev page, pass min sort value from next page
Efficient prev page, pass min ES sort value from next page
Size is limited to 1000, if not passed it defaults to 0, and no results will return
SkipAggregateAccounts flag that indicates whether to skip aggregate accounts results
Widget type describes how does the widget should recieve the data, and display it. Supporting types: "bar", "column", "pie", "list", "number", "trend", "text", "duration", "image", "line", and "table".
POST /widgets HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2345
{
"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"
}The saved widget newest version.
{
"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"
}Import a widget to the system, ignoring ID or version, used to import new widgets.
The JSON file of the widget to import.
The saved widget
Widget describe a widget component used to get statistics requests, based on parameters such as dataType and widgetType. A widget can be a part of widgets collection inside a dashboard.
Category the widget is related to. Used to display in widget library under category or dataType if empty.
Data type of the widget. Describes what data does the widget query. supporting data types "incidents","messages","system","entries","tasks", "audit".
The description of the widget's usage and data representation.
Do not use workers mechanism while searching bleve
Is the widget a system widget.
Is the widget locked for editing.
Default name of the widget.
0-based page
The previous name of the widget.
Query to search on the dataType.
Efficient next page, pass max sort value from previous page
Efficient next page, pass max ES sort value from previous page
Efficient prev page, pass min sort value from next page
Efficient prev page, pass min ES sort value from next page
Size is limited to 1000, if not passed it defaults to 0, and no results will return
SkipAggregateAccounts flag that indicates whether to skip aggregate accounts results
Widget type describes how does the widget should recieve the data, and display it. Supporting types: "bar", "column", "pie", "list", "number", "trend", "text", "duration", "image", "line", and "table".
POST /widgets/import HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15
{
"file": "text"
}The saved 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"
}Get a widget object by a given ID.
The ID of widget to get.
Return the widget if found.
Widget describe a widget component used to get statistics requests, based on parameters such as dataType and widgetType. A widget can be a part of widgets collection inside a dashboard.
Category the widget is related to. Used to display in widget library under category or dataType if empty.
Data type of the widget. Describes what data does the widget query. supporting data types "incidents","messages","system","entries","tasks", "audit".
The description of the widget's usage and data representation.
Do not use workers mechanism while searching bleve
Is the widget a system widget.
Is the widget locked for editing.
Default name of the widget.
0-based page
The previous name of the widget.
Query to search on the dataType.
Efficient next page, pass max sort value from previous page
Efficient next page, pass max ES sort value from previous page
Efficient prev page, pass min sort value from next page
Efficient prev page, pass min ES sort value from next page
Size is limited to 1000, if not passed it defaults to 0, and no results will return
SkipAggregateAccounts flag that indicates whether to skip aggregate accounts results
Widget type describes how does the widget should recieve the data, and display it. Supporting types: "bar", "column", "pie", "list", "number", "trend", "text", "duration", "image", "line", and "table".
GET /widgets/{id} HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
Return the widget if found.
{
"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"
}Remove a given widget Id from the system.
Widget id to remove (returned from widget save or widgets get)
widget deleted
No content
DELETE /widgets/{id} HTTP/1.1
Host: hostname
Authorization: YOUR_API_KEY
Accept: */*
widget deleted
No content
Last updated
Was this helpful?