Get Session By Custom ID

Retrieve a specific session by its Custom ID.

Returns

Returns a Session object.

Example

session_by_custom = galtea.sessions.get_by_custom_id(custom_id=custom_session_id, version_id=version_id)

Parameters

custom_id · string · required

The Custom ID associated with the session to retrieve.

A custom ID is unique only per version, so a version_id or product_id anchor is required to resolve it unambiguously.

version_id · string

The version to look the session up on. Provide this or product_id (at least one is required). If both are given, version_id wins and product_id is ignored.

product_id · string

The product to search across (any of its versions) when no version_id is given. If more than one version has a session with this custom ID, the most recently created one is returned.