分析コレクションへのイベントの投稿

この機能はベータ版であり、変更される可能性があります。設計とコードは公式GA機能よりも成熟しておらず、保証なしでそのまま提供されています。ベータ機能は公式GA機能のサポートSLAの対象外です。

行動分析コレクションにイベントを投稿します。

リクエスト

POST _application/analytics/<collection_name>/event/<event_type>

パスパラメータ

  • <collection_name>
  • (必須、文字列)イベントを取り込む分析コレクションの名前。
  • <event_type>
  • (必須、文字列)分析イベントのタイプ。page_viewsearchsearch_clickのいずれかです。

リクエストボディ

完全なリクエストボディパラメータは、イベントリファレンスで確認できます。

前提条件

  1. ## レスポンスコード
  2. - `````202
  • イベントが受け入れられ、取り込まれます。
  • 404
  • 分析コレクション<collection_name>は存在しません。
  • 400
  • イベントタイプが不明な場合、またはイベントペイロードに無効なデータが含まれている場合に発生します。

次の例は、my_analytics_collectionという分析コレクションにsearch_clickイベントを送信します:

Python

  1. resp = client.search_application.post_behavioral_analytics_event(
  2. collection_name="my_analytics_collection",
  3. event_type="search_click",
  4. body={
  5. "session": {
  6. "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
  7. },
  8. "user": {
  9. "id": "5f26f01a-bbee-4202-9298-81261067abbd"
  10. },
  11. "search": {
  12. "query": "search term",
  13. "results": {
  14. "items": [
  15. {
  16. "document": {
  17. "id": "123",
  18. "index": "products"
  19. }
  20. }
  21. ],
  22. "total_results": 10
  23. },
  24. "sort": {
  25. "name": "relevance"
  26. },
  27. "search_application": "website"
  28. },
  29. "document": {
  30. "id": "123",
  31. "index": "products"
  32. }
  33. },
  34. )
  35. print(resp)

Js

  1. const response = await client.searchApplication.postBehavioralAnalyticsEvent({
  2. collection_name: "my_analytics_collection",
  3. event_type: "search_click",
  4. body: {
  5. session: {
  6. id: "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9",
  7. },
  8. user: {
  9. id: "5f26f01a-bbee-4202-9298-81261067abbd",
  10. },
  11. search: {
  12. query: "search term",
  13. results: {
  14. items: [
  15. {
  16. document: {
  17. id: "123",
  18. index: "products",
  19. },
  20. },
  21. ],
  22. total_results: 10,
  23. },
  24. sort: {
  25. name: "relevance",
  26. },
  27. search_application: "website",
  28. },
  29. document: {
  30. id: "123",
  31. index: "products",
  32. },
  33. },
  34. });
  35. console.log(response);

コンソール

  1. POST _application/analytics/my_analytics_collection/event/search_click
  2. {
  3. "session": {
  4. "id": "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9"
  5. },
  6. "user": {
  7. "id": "5f26f01a-bbee-4202-9298-81261067abbd"
  8. },
  9. "search":{
  10. "query": "search term",
  11. "results": {
  12. "items": [
  13. {
  14. "document": {
  15. "id": "123",
  16. "index": "products"
  17. }
  18. }
  19. ],
  20. "total_results": 10
  21. },
  22. "sort": {
  23. "name": "relevance"
  24. },
  25. "search_application": "website"
  26. },
  27. "document":{
  28. "id": "123",
  29. "index": "products"
  30. }
  31. }