Create a behavioral analytics collection event Technical preview

POST /_application/analytics/{collection_name}/event/{event_type}
Api key auth Basic auth Bearer auth
External documentation

Path parameters

  • collection_name string Required

    The name of the behavioral analytics collection.

  • event_type string

    The analytics event type.

    Values are page_view, search, or search_click.

Query parameters

  • debug boolean

    Whether the response type has to include more details

application/json

Body Required

object object

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • accepted boolean Required
    • event object
POST /_application/analytics/{collection_name}/event/{event_type} 
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" } }
resp = client.search_application.post_behavioral_analytics_event( collection_name="my_analytics_collection", event_type="search_click", payload={ "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" } }, )
const response = await client.searchApplication.postBehavioralAnalyticsEvent({ collection_name: "my_analytics_collection", event_type: "search_click", payload: { 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", }, }, });
response = client.search_application.post_behavioral_analytics_event( collection_name: "my_analytics_collection", event_type: "search_click", body: { "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" } } )
$resp = $client->searchApplication()->postBehavioralAnalyticsEvent([ "collection_name" => "my_analytics_collection", "event_type" => "search_click", "body" => [ "session" => [ "id" => "1797ca95-91c9-4e2e-b1bd-9c38e6f386a9", ], "user" => [ "id" => "5f26f01a-bbee-4202-9298-81261067abbd", ], "search" => [ "query" => "search term", "results" => [ "items" => array( [ "document" => [ "id" => "123", "index" => "products", ], ], ), "total_results" => 10, ], "sort" => [ "name" => "relevance", ], "search_application" => "website", ], "document" => [ "id" => "123", "index" => "products", ], ], ]);
curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"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"}}' "$ELASTICSEARCH_URL/_application/analytics/my_analytics_collection/event/search_click"
client.searchApplication().postBehavioralAnalyticsEvent(p -> p .collectionName("my_analytics_collection") .eventType(EventType.SearchClick) .payload(JsonData.fromJson("{\"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\"}}")) );
Request example
Run `POST _application/analytics/my_analytics_collection/event/search_click` to send a `search_click` event to an analytics collection called `my_analytics_collection`. 
{ "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" } }