This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Delete Analytics Collection Post Event to an Analytics Collection »

› › ›

List Analytics Collections

edit

List Analytics Collections

edit

This 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 Behavioral Analytics Collections.

Request

edit

GET _application/analytics/<criteria>

Prerequisites

edit

Requires 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

edit

Examples

edit

The following example lists all configured Analytics Collections:

resp = client.search_application.get_behavioral_analytics()
print(resp)

const response = await client.searchApplication.getBehavioralAnalytics();
console.log(response);

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:

resp = client.search_application.get_behavioral_analytics(
    name="my_analytics_collection",
)
print(resp)

const response = await client.searchApplication.getBehavioralAnalytics({
  name: "my_analytics_collection",
});
console.log(response);

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:

resp = client.search_application.get_behavioral_analytics(
    name="my*",
)
print(resp)

const response = await client.searchApplication.getBehavioralAnalytics({
  name: "my*",
});
console.log(response);

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"
      }
  }
}

« Delete Analytics Collection Post Event to an Analytics Collection »