Version 1.0.0; last updated 2024-06-14. An event that occurred, typically in response to a user.
name of the application tracking UBI events.
Must be at most 100 characters long
"amazon-shop"
"ABC-microservice"
"doctor-search"
The name of the action that triggered the event. We have a set of common defaults, however you can pass in whatever you want.
Must be at most 100 characters long
The unique identifier of a query, typically a UUID, but can be any string.
"00112233-4455-6677-8899-aabbccddeeff"
Must be at most 100 characters long
"1234-user-5678"
The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot. If only authenticated users are tracked, then you could use a specific user id here, otherwise you should use something permanent and track user id as an Additional Property.
Must be at most 100 characters long
"5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5"
"quepid-nightly-bot"
"BugsBunny::Firefox@0967084"
When the event took place.
"2018-11-13T20:20:39+00:00"
Group various action_name's into logical bins.
Must be at most 100 characters long
"QUERY"
"CONVERSION"
Optional text message for the log entry. For example, for a message_type of QUERY, we would expect the text to be about what the user is searching on.
Must be at most 1024 characters long
Extensible details about a specific event. A common example of an Additional Properties is the specific identifier of the user (user_id). Note: a user identifier is different then the required client_id attribute.
Structure which contains identifying information of the object returned from the query that the user interacts with (i.e.: a book, a product, a post, etc..).
The id that a user could look up and find the object instance within the document corpus. Examples include: ssn, isbn, ean, etc. Variants need to be incorporated in the object_id, so for a t-shirt that is red, you would need SKU level as the object_id.
Must be at most 256 characters long
"XYZ-12345"
"ISBN 0-061-96436-0"
"123"
The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be sku and if you are querying for people, maybe this is ssn. If you do not provide this value then the default primary identifier in your search index will be used. For example _id on OpenSearch.
Must be at most 100 characters long
A unique id that the an individual search engine uses internally to index the object via. For example, in OpenSearch, think the _id field in the indices.
Must be at most 256 characters long
"1"
"123456"
Additional Properties of any type are allowed.
Type: objectStructure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results.
The nth position of the document on the search results page.
The position of the document. For grid layout this would be left to right, ignoring wrapping.
1
3
24
The x,y coordinates on the screen for triggering an event.
The horizontal location on the page or screen of the event.
The vertical location on the page or screen of the event.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: object