diff --git a/docs/html/1.2.0/event.schema.html b/docs/html/1.2.0/event.schema.html index 70e10a8..48bd10b 100644 --- a/docs/html/1.2.0/event.schema.html +++ b/docs/html/1.2.0/event.schema.html @@ -1,6 +1,8 @@ - Event tracking for UBI

Event tracking for UBI

Type: object

Version 1.2.0; last updated 2024-???. An event that occurred, typically in response to a user.

root application
Type: string

name of the application tracking UBI events.

Must be at most 100 characters long


Examples:

"amazon-shop"
-
"ABC-microservice"
-
"doctor-search"
+ Event tracking for UBI 
   
 
 
Event tracking for UBI
Type: object
 
Version 1.2.0; last updated 2024-???. An event that occurred, typically in response to a user.
  
 
 
 
  
 
 
 
 
root    application
Type: string
 
Name of the application that is integrated with UBI. You can think of application as in a source of search queries. For example, if you have a type ahead and a traditional search UI, then you might have type-ahead and primary-search as values.
  
Must be at most 100 characters long
 
 
Examples:
 
"type-ahead"
+
 
"primary-search"
+
 
"amazon-shop"
+
 
"ABC-microservice"
+
 
"doctor-search"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    action_name

 
The name of the action that triggered the event. We have a set of common defaults, however you can pass in whatever you want.
 
  
 
 
root    action_name    oneOf    item 0
Type: enum (of string)
 
 
Must be one of:
 
  • "click_through"
  • "add_to_cart"
  • "click"
  • "watch"
  • "view"
  • "purchase"
  • "impression"
 
 
 
root    action_name    oneOf    item 1
Type: string
 
Must be at most 100 characters long
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    query_id

 
The unique identifier of a query, typically a UUID, but can be any string.
 
  
 
 
root    query_id    oneOf    item 0
Type: stringFormat: uuid
 
 
Example:
 
"00112233-4455-6677-8899-aabbccddeeff"
 
 
 
 
root    query_id    oneOf    item 1
Type: string
 
Must be at most 100 characters long
 
 
Example:
 
"1234-user-5678"
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    session_id
Type: string
 
The session of the user creating the interactions. This allows us to correlate the interactions with the other events created by a service that recognizes session IDs. Can be used to track unique visits for authenticated and anonymous users.
  
Must be at most 100 characters long
 
 
Example:
 
"84266fdbd31d4c2c6d0665f7e8380fa3"
@@ -19,4 +21,4 @@
 
 
 
 
 
 
 
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 
root    event_attributes    object    additionalProperties
Type: object

root event_attributes position

Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results.

root event_attributes position oneOf item 0
Type: object

root event_attributes position oneOf item 0 ordinal
Type: object

The nth position of the document on the search results page.

root event_attributes position oneOf item 0 ordinal index
Type: integer

The position of the document. For grid layout this would be left to right, ignoring wrapping.
Examples:

1
 
3
 
24
-
root event_attributes position oneOf item 1
Type: object

root event_attributes position oneOf item 1 xy
Type: object

The x,y coordinates on the screen for triggering an event.

root event_attributes position oneOf item 1 xy x
Type: number

The horizontal location on the page or screen of the event.

root event_attributes position oneOf item 1 xy y
Type: number

The vertical location on the page or screen of the event.

Additional Properties of any type are allowed.

root event_attributes position additionalProperties
Type: object

Additional Properties of any type are allowed.

root event_attributes additionalProperties
Type: object
\ No newline at end of file +
root event_attributes position oneOf item 1
Type: object

root event_attributes position oneOf item 1 xy
Type: object

The x,y coordinates on the screen for triggering an event.

root event_attributes position oneOf item 1 xy x
Type: number

The horizontal location on the page or screen of the event.

root event_attributes position oneOf item 1 xy y
Type: number

The vertical location on the page or screen of the event.

Additional Properties of any type are allowed.

root event_attributes position additionalProperties
Type: object

Additional Properties of any type are allowed.

root event_attributes additionalProperties
Type: object
\ No newline at end of file diff --git a/docs/html/1.2.0/query.request.schema.html b/docs/html/1.2.0/query.request.schema.html index 3514458..6084c4d 100644 --- a/docs/html/1.2.0/query.request.schema.html +++ b/docs/html/1.2.0/query.request.schema.html @@ -1,7 +1,12 @@ - Query Tracking for UBI

Query Tracking for UBI

Type: object

Version 1.2.0; last updated 2024-??. A query made by a user should include these attributes for UBI tracking.

root query_id

The unique identifier of a query, typically a UUID, but can be any string.

root query_id oneOf item 0
Type: stringFormat: uuid

Example:

"00112233-4455-6677-8899-aabbccddeeff"
+ Query Tracking for UBI 
   
 
 
Query Tracking for UBI
Type: object
 
Version 1.2.0; last updated 2024-??. A query made by a user should include these attributes for UBI tracking.
  
 
 
 
  
 
 
 
 
root    application
Type: string
 
Name of the application that is integrated with UBI. You can think of application as in a source of search queries. For example, if you have a type ahead and a traditional search UI, then you might have type-ahead and primary-search as values.
  
Must be at most 100 characters long
 
 
Examples:
 
"type-ahead"
+
 
"primary-search"
+
 
"amazon-shop"
+
 
"ABC-microservice"
+
 
"doctor-search"
+
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    query_id

 
The unique identifier of a query, typically a UUID, but can be any string.
 
  
 
 
root    query_id    oneOf    item 0
Type: stringFormat: uuid
 
 
Example:
 
"00112233-4455-6677-8899-aabbccddeeff"
 
 
 
 
root    query_id    oneOf    item 1
Type: string
 
Must be at most 100 characters long
 
 
Example:
 
"1234-user-5678"
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    client_id
Type: string
 
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
 
 
Examples:
 
"5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5"
 
 
"quepid-nightly-bot"
 
 
"BugsBunny::Firefox@0967084"
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    user_query
Type: string
 
The query as the user entered it. No length limit specified.
  
 
 
 
 
 
 
 
  
 
 
 
 
root    query_attributes
Type: object
 
Any query modifiers like filter choices or pagination. Other attributes such as experiment identifiers that need to be tracked with the query.
  
 
 
 
  
 
 
 
Additional Properties of any type are allowed.
 
root    query_attributes    additionalProperties
Type: object
 
 
 
 
 
 
 
 
 
 
 
 
  
 
 
 
 
root    object_id_field
Type: string
 
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
 
 
 
 
 
 
 
 
  
 
 
 
 
root    timestamp
Type: stringFormat: date-time
 
When the query was issued. This timestamp is formatted according to the ISO 8601 standard. In many implementations of the UBI Query plugin the timestamp will be set for you at the time of the query being run. If you are replaying data, or want to track the timezone of the caller specifically, instead of using the search engine's timezone, then you will need to provide the timestamp instead.
  
 
Example:
 
"2018-11-13T20:20:39+00:00"
-
 
 
 
 
 
  
\ No newline at end of file
+
\ No newline at end of file diff --git a/docs/html/1.2.0/query.response.schema.html b/docs/html/1.2.0/query.response.schema.html index cae68ed..11ce200 100644 --- a/docs/html/1.2.0/query.response.schema.html +++ b/docs/html/1.2.0/query.response.schema.html @@ -1,3 +1,3 @@ Query Response When Using UBI

Query Response When Using UBI

Type: object

Version 1.2.0; last updated 2024-??. The response to a query made by a user should support this schema.

root query_id

The unique identifier of a query, typically a UUID, but can be any string.

root query_id oneOf item 0
Type: stringFormat: uuid

Example:

"00112233-4455-6677-8899-aabbccddeeff"
root query_id oneOf item 1
Type: string

Must be at most 100 characters long


Example:

"1234-user-5678"
-
\ No newline at end of file +
\ No newline at end of file diff --git a/schema/1.2.0/event.schema.json b/schema/1.2.0/event.schema.json index 126d7c6..8cc2aa5 100644 --- a/schema/1.2.0/event.schema.json +++ b/schema/1.2.0/event.schema.json @@ -7,10 +7,12 @@ "required": ["action_name", "timestamp"], "properties": { "application": { - "description": "name of the application tracking UBI events.", + "description": "Name of the application that is integrated with UBI. You can think of application as in a source of search queries. For example, if you have a type ahead and a traditional search UI, then you might have `type-ahead` and `primary-search` as values.", "type": "string", "maxLength": 100, "examples": [ + "type-ahead", + "primary-search", "amazon-shop", "ABC-microservice", "doctor-search" diff --git a/schema/1.2.0/query.request.schema.json b/schema/1.2.0/query.request.schema.json index 2cdad1a..ca7b402 100644 --- a/schema/1.2.0/query.request.schema.json +++ b/schema/1.2.0/query.request.schema.json @@ -6,6 +6,18 @@ "type": "object", "required": [ "user_query" ], "properties": { + "application": { + "description": "Name of the application that is integrated with UBI. You can think of application as in a source of search queries. For example, if you have a type ahead and a traditional search UI, then you might have `type-ahead` and `primary-search` as values.", + "type": "string", + "maxLength": 100, + "examples": [ + "type-ahead", + "primary-search", + "amazon-shop", + "ABC-microservice", + "doctor-search" + ] + }, "query_id": { "description": "The unique identifier of a query, typically a UUID, but can be any string.", "oneOf": [