« Autoscaling APIs Compact and aligned text (CAT) APIs »
Elastic Docs ›Elasticsearch Guide ›REST APIs

行为分析API

edit

行为分析 API

edit

此功能处于测试阶段，可能会发生变化。设计和代码不如正式发布的功能成熟，并且是按原样提供的，不提供任何保证。测试功能不受正式发布功能的支持服务级别协议的约束。

使用以下API来管理与行为分析相关的任务和资源：

使用以下API将事件摄取到Analytics集合中：

放置分析集合

edit

此功能处于测试阶段，可能会发生变化。设计和代码不如正式发布的功能成熟，并且是按原样提供的，不提供任何保证。测试功能不受正式发布功能的支持服务级别协议的约束。

创建一个行为分析集合。

请求

edit

PUT _application/analytics/

路径参数

edit
<name>
（必需，字符串）

先决条件

edit

需要 manage_behavioral_analytics 集群权限。

响应代码

edit
400
分析集合 存在。

示例

edit

以下示例创建了一个名为 my_analytics_collection 的新分析集合：

PUT _application/analytics/my_analytics_collection

删除分析集合

edit

此功能处于测试阶段，可能会发生变化。设计和代码不如正式发布的功能成熟，并且是按原样提供的，不提供任何保证。测试功能不受正式发布功能的支持服务级别协议的约束。

删除一个行为分析集合及其关联的数据流。

请求

edit

DELETE _application/analytics/

先决条件

edit

需要 manage_behavioral_analytics 集群权限。

路径参数

edit
<name>
（必需，字符串）

响应代码

edit
400
未提供名称。
404 (Missing resources)
未找到与名称匹配的分析集合。

示例

edit

以下示例删除了名为 my_analytics_collection 的分析集合：

DELETE _application/analytics/my_analytics_collection/

列出分析集合

edit

此功能处于测试阶段，可能会发生变化。设计和代码不如正式发布的功能成熟，并且是按原样提供的，不提供任何保证。测试功能不受正式发布功能的支持服务级别协议的约束。

返回有关行为分析集合的信息。

请求

edit

GET _application/analytics/

先决条件

edit

需要 manage_behavioral_analytics 集群权限。

路径参数

edit
<criteria>
(可选, 字符串) 标准用于查找匹配的分析集合。这可以是集合的名称或用于匹配多个集合的模式。如果未指定，将返回所有分析集合。

响应代码

edit
404
标准与任何分析集合不匹配。

响应代码

edit

示例

edit

以下示例列出了所有已配置的分析集合：

GET _application/analytics/

一个示例响应：

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

以下示例返回与 my_analytics_collection 匹配的分析集合：

GET _application/analytics/my_analytics_collection

一个示例响应：

{
  "my_analytics_collection": {
      "event_data_stream": {
          "name": "behavioral_analytics-events-my_analytics_collection"
      }
  }
}

以下示例返回所有以 my 为前缀的分析集合：

GET _application/analytics/my*

一个示例响应：

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

向分析集合发布事件

edit

此功能处于测试阶段，可能会发生变化。设计和代码不如正式发布的功能成熟，并且是按原样提供的，不提供任何保证。测试功能不受正式发布功能的支持服务级别协议的约束。

向一个行为分析集合发布事件。

请求

edit

POST _application/analytics//event/

路径参数

edit
<collection_name>
(必需，字符串) 您希望在其中摄取事件的分析集合名称。
<event_type>
(必需，字符串) 分析事件类型。可以是以下之一：page_view、search、search_click。

请求体

edit

完整的请求体参数可以在以下位置找到：事件参考。

先决条件

edit

需要 post_behavioral_analytics_event 集群权限。

响应代码

edit
202
事件已被接受并将被处理。
404
Analytics Collection 不存在。
400
当事件类型未知或事件负载包含无效数据时发生。

示例

edit

以下示例向名为 my_analytics_collection 的分析集合发送一个 search_click 事件：

POST _application/analytics/my_analytics_collection/event/search_click
{
  "session": {
    "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
  },
  "user": {
    "id": "5f26f01a-bbee-4202-9298-81261067abbd"
  },
  "search":{
    "query": "search term",
    "results": {
      "items": [
        {
          "document": {
            "id": "123",
            "index": "products"
          }
        }
      ],
      "total_results": 10
    },
    "sort": {
      "name": "relevance"
    },
    "search_application": "website"
  },
  "document":{
    "id": "123",
    "index": "products"
  }
}
« Autoscaling APIs Compact and aligned text (CAT) APIs »