Skip to main content
GET
/
api
/
v1
/
sessions
/
{sessionId}
Get a session
curl --request GET \
  --url https://api.getdecipher.com/api/v1/sessions/{sessionId} \
  --header 'Authorization: Bearer <token>'
{
  "object": "session",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "createdAt": "<string>",
  "duration": 123,
  "userEmail": "<string>",
  "userId": "<string>",
  "userAccount": "<string>",
  "userUsername": "<string>",
  "userPlan": "<string>",
  "userRole": "<string>",
  "browser": "<string>",
  "device": "<string>",
  "countryCode": "<string>",
  "hasTimeline": true,
  "timelineOverview": "<string>",
  "tags": [
    "<string>"
  ],
  "pagesVisited": [
    {
      "page": "<string>",
      "startTime": 123,
      "endTime": 123,
      "clickCount": 123,
      "featuresUsed": [
        "<string>"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getdecipher.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key authentication. Use your Decipher API key as the bearer token.

Path Parameters

sessionId
string<uuid>
required

The UUID of the session

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Response

Session details

object
enum<string>
required
Available options:
session
id
string<uuid>
required
url
string
required

Decipher dashboard link for the session

createdAt
string
required
duration
number | null
required
userEmail
string | null
required
userId
string | null
required
userAccount
string | null
required
userUsername
string | null
required
userPlan
string | null
required
userRole
string | null
required
browser
string | null
required
device
string | null
required
countryCode
string | null
required
hasTimeline
boolean
required
timelineOverview
string | null
required

AI-generated overview of the session

tags
string[]
required

Matched behavior tags from AI analysis

pagesVisited
object[]
required