IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
List Analytics Collections
editList Analytics Collections
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Returns information about Analytics Collections.
Request
editGET _application/analytics/<criteria>
Prerequisites
editRequires the manage_behavioral_analytics cluster privilege.
Path parameters
edit-
<criteria> - (optional, string) Criteria is used to find a matching analytics collection. This could be the name of the collection or a pattern to match multiple. If not specified, will return all analytics collections.
Response codes
edit-
404 - Criteria does not match any Analytics Collections.
Response codes
editExamples
editThe following example lists all configured Analytics Collections:
GET _application/analytics/
A sample response:
{
"my_analytics_collection": {
"event_data_stream": {
"name": "behavioral_analytics-events-my_analytics_collection"
}
},
"my_analytics_collection2": {
"event_data_stream": {
"name": "behavioral_analytics-events-my_analytics_collection2"
}
}
}
The following example returns the Analytics Collection that matches my_analytics_collection:
GET _application/analytics/my_analytics_collection
A sample response:
{
"my_analytics_collection": {
"event_data_stream": {
"name": "behavioral_analytics-events-my_analytics_collection"
}
}
}
The following example returns all Analytics Collections prefixed with my:
GET _application/analytics/my*
A sample response:
{
"my_analytics_collection": {
"event_data_stream": {
"name": "behavioral_analytics-events-my_analytics_collection"
}
},
"my_analytics_collection2": {
"event_data_stream": {
"name": "behavioral_analytics-events-my_analytics_collection2"
}
}
}