From c6d0e48f694daaad387d2d810e775bd54c51ae07 Mon Sep 17 00:00:00 2001 From: Ankit Siva Date: Wed, 7 Aug 2024 09:08:56 -0700 Subject: [PATCH] feat[event.schema.json]: add session_id --- schema/1.0.0/event.schema.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/schema/1.0.0/event.schema.json b/schema/1.0.0/event.schema.json index e6e89cb..10749a5 100644 --- a/schema/1.0.0/event.schema.json +++ b/schema/1.0.0/event.schema.json @@ -4,7 +4,7 @@ "title": "Event tracking for UBI", "description": "Version 1.0.0; last updated 2024-06-14. An event that occurred, typically in response to a user.", "type": "object", - "required": ["action_name", "query_id", "timestamp"], + "required": ["action_name", "query_id", "session_id", "timestamp"], "properties": { "application": { "description": "name of the application tracking UBI events.", @@ -45,6 +45,12 @@ } ] }, + "session_id": { + "description": "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.", + "type": "string", + "maxLength": 100, + "examples": ["84266fdbd31d4c2c6d0665f7e8380fa3"] + }, "client_id": { "description": "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_.", "type": "string",