Get draft Timeline or Timeline template details
Get the details of the draft Timeline or Timeline template for the current user. If the user doesn't have a draft Timeline, an empty Timeline is returned.
Query parameters
-
The type of timeline to create. Valid values are
defaultandtemplate.Values are
defaultortemplate.
Responses
-
200 application/json
Indicates that the draft Timeline was successfully retrieved.
-
403 application:json
If a draft Timeline was not found and we attempted to create one, it indicates that the user does not have the required permissions to create a draft Timeline.
-
409 application:json
This should never happen, but if a draft Timeline was not found and we attempted to create one, it indicates that there is already a draft Timeline with the given
timelineId.
GET
/api/timeline/_draft
curl \
--request GET https://localhost:5601/api/timeline/_draft?timelineType=default
Response examples (200)
{
"columns": [
{
"aggregatable": true,
"category": "string",
"columnHeaderType": "string",
"description": "string",
"example": "string",
"id": "string",
"indexes": [
"string"
],
"name": "string",
"placeholder": "string",
"searchable": true,
"type": "string"
}
],
"created": 42.0,
"createdBy": "string",
"dataProviders": [
{
"and": [
{
"enabled": true,
"excluded": true,
"id": "string",
"kqlQuery": "string",
"name": "string",
"queryMatch": {
"displayField": "string",
"displayValue": "string",
"field": "string",
"operator": "string",
"value": "string"
},
"type": "default"
}
],
"enabled": true,
"excluded": true,
"id": "string",
"kqlQuery": "string",
"name": "string",
"queryMatch": {
"displayField": "string",
"displayValue": "string",
"field": "string",
"operator": "string",
"value": "string"
},
"type": "default"
}
],
"dataViewId": "string",
"dateRange": {
"end": "string",
"start": "string"
},
"description": "string",
"eqlOptions": {
"eventCategoryField": "string",
"query": "string",
"size": "string",
"tiebreakerField": "string",
"timestampField": "string"
},
"eventType": "string",
"excludedRowRendererIds": [
"alert"
],
"favorite": [
{
"favoriteDate": 42.0,
"fullName": "string",
"userName": "string"
}
],
"filters": [
{
"exists": "string",
"match_all": "string",
"meta": {
"alias": "string",
"controlledBy": "string",
"disabled": true,
"field": "string",
"formattedValue": "string",
"index": "string",
"key": "string",
"negate": true,
"params": "string",
"type": "string",
"value": "string"
},
"missing": "string",
"query": "string",
"range": "string",
"script": "string"
}
],
"indexNames": [
"string"
],
"kqlMode": "string",
"kqlQuery": {
"filterQuery": {
"kuery": {
"expression": "string",
"kind": "string"
},
"serializedQuery": "string"
}
},
"savedQueryId": "string",
"savedSearchId": "string",
"sort": {
"columnId": "string",
"columnType": "string",
"sortDirection": "string"
},
"status": "active",
"templateTimelineId": "string",
"templateTimelineVersion": 42.0,
"timelineType": "default",
"title": "string",
"updated": 42.0,
"updatedBy": "string",
"savedObjectId": "string",
"version": "string",
"eventIdToNoteIds": [
{
"created": 42.0,
"createdBy": "string",
"eventId": "string",
"note": "string",
"timelineId": "string",
"updated": 42.0,
"updatedBy": "string",
"noteId": "string",
"version": "string"
}
],
"noteIds": [
"string"
],
"notes": [
{
"created": 42.0,
"createdBy": "string",
"eventId": "string",
"note": "string",
"timelineId": "string",
"updated": 42.0,
"updatedBy": "string",
"noteId": "string",
"version": "string"
}
],
"pinnedEventIds": [
"string"
],
"pinnedEventsSaveObject": [
{
"created": 42.0,
"createdBy": "string",
"eventId": "string",
"timelineId": "string",
"updated": 42.0,
"updatedBy": "string",
"pinnedEventId": "string",
"version": "string"
}
]
}
Response examples (403)
{
"message": "string",
"status_code": 42.0
}
Response examples (409)
{
"message": "string",
"status_code": 42.0
}