v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB

V4 Session

Look up a session under a given site

This endpoint allows you to access specific session details for a particular site. By providing the unique identifiers for the site and the session, you can retrieve detailed information about that session. This information can include the session's start time, end time, current status, and any associated user data. The exact content of the response will depend on the specific session and site identifiers provided in the request.

get/v4/sessions/{site}/{sessionId}

Path parameters

sitestring required

The unique site identifier within the tenant.

sessionIdstring required

Unique session identifier assigned to each session, enabling precise identification and retrieval of session-related information within the API.

Response

OK. Returns the session details.

tenantIdstring

subTenantIdstring

authenticatedboolean

vinteger

version

session_variablesSessionVariables

user_idstring

last_updatedinteger

A timestamp indicating the last update of the session, measured in milliseconds since the epoch.

test_groupsobject

second_party_dataobject

Example response

{
  "tenantId": "company",
  "subTenantId": "company|demo",
  "authenticated": true,
  "user_id": "UU0123456789ABCD",
  "sessions": [
    {
      "tenantId": "company",
      "subTenantId": "company|demo",
      "expiryDate": "2025-02-08 14:29 PM UTC",
      "startDate": "2024-02-08 14:29 PM UTC",
      "authenticated": true,
      "state": "authenticated",
      "device": "pc",
      "browser": "Chrome",
      "os": "Mac OSX",
      "city": "London",
      "geoState": "London",
      "deviceName": "Apple Macintosh",
      "country": "GB",
      "session_id": "26a73b7a-f7d0-48d8-85dd-a04b07313895",
      "user_id": "UU0123456789ABCD"
    }
  ],
  "access_model": {
    "delivered_entitlements": [
      {
        "id": "0123456789ABCD",
        "direct": true,
        "meteredBy": [],
        "creditedBy": []
      }
    ],
    "granted_bundles": [
      "e10a5ff3-fc63-47fb-af04-75c2ec3fdf1c"
    ],
    "jwt_bundles": [],
    "user_state": "registered"
  },
  "last_updated": 1707230240685
}