123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111 |
- [role="xpack"]
- [[list-analytics-collection]]
- === List Analytics Collections
- ++++
- <titleabbrev>List Analytics Collections</titleabbrev>
- ++++
- Returns information about Analytics Collections.
- [[list-analytics-collection-request]]
- ==== {api-request-title}
- `GET _application/analytics/<criteria>`
- [[list-analytics-collection-prereq]]
- ==== {api-prereq-title}
- Requires the `manage_behavioral_analytics` cluster privilege.
- [[list-analytics-collection-path-params]]
- ==== {api-path-parms-title}
- `<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.
- [[list-analytics-collection-response-codes]]
- ==== {api-response-codes-title}
- `404`::
- Criteria does not match any Analytics Collections.
- ==== {api-response-codes-title}
- [[list-analytics-collection-example]]
- ==== {api-examples-title}
- The following example lists all configured Analytics Collections:
- [source,console]
- ----
- GET _application/analytics/
- ----
- // TEST[skip:TBD]
- A sample response:
- [source,console-result]
- ----
- {
- "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`:
- [source,console]
- ----
- GET _application/analytics/my_analytics_collection
- ----
- // TEST[skip:TBD]
- A sample response:
- [source,console-result]
- ----
- {
- "my_analytics_collection": {
- "event_data_stream": {
- "name": "behavioral_analytics-events-my_analytics_collection"
- }
- }
- }
- ----
- The following example returns all Analytics Collections prefixed with `my`:
- [source,console]
- ----
- GET _application/analytics/my*
- ----
- // TEST[skip:TBD]
- A sample response:
- [source,console-result]
- ----
- {
- "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"
- }
- }
- }
- ----
- // TEST[skip:TBD]
|