Skip to main content
GET
/
api
/
v1
/
monitoring
/
issue-collections
/
{collectionId}
/
sessions
List sessions for an issue collection
curl --request GET \
  --url https://api.getdecipher.com/api/v1/monitoring/issue-collections/{collectionId}/sessions \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "collection": {
    "id": 123,
    "type": "<string>",
    "rootCause": "<string>",
    "shortenedPath": "<string>",
    "createdAt": "<string>",
    "isResolved": true,
    "errorCount": 123,
    "sessionCount": 123,
    "estimatedUsers": 123
  },
  "data": [
    {
      "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,
      "representativeIssue": {
        "errorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "latestIssueAt": "<string>",
        "shortenedPath": "<string>",
        "fullPath": "<string>",
        "aiSummary": {
          "category": "<string>",
          "behavior": "<string>",
          "productFeature": "<string>",
          "errorText": "<string>",
          "reasoning": "<string>"
        }
      },
      "timeline": {
        "overview": "<string>",
        "tags": [
          {
            "tag": "<string>",
            "reasoning": "<string>"
          }
        ],
        "pages": [
          {
            "page": "<string>",
            "startTime": 123,
            "endTime": 123,
            "clickCount": 123,
            "featuresUsed": [
              "<string>"
            ],
            "activities": [
              {
                "startTime": "<string>",
                "endTime": "<string>",
                "summary": "<string>",
                "userAction": "<string>",
                "userBehavior": "<string>"
              }
            ]
          }
        ],
        "loadingIssues": [
          {
            "description": "<string>",
            "longDescription": "<string>",
            "durationInSeconds": 123,
            "timestamp": 123
          }
        ]
      },
      "clicks": [
        {
          "id": 123,
          "type": "<string>",
          "timestamp": 123,
          "clickCount": 123,
          "navigationTo": "<string>",
          "screenshots": {
            "before": "<string>",
            "after": "<string>"
          }
        }
      ],
      "errorScreenshots": {
        "main": "<string>",
        "after": "<string>"
      }
    }
  ],
  "includes": [
    "timeline"
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "window": {
    "since": "<string>",
    "until": "<string>"
  },
  "screenshotsExpiresAt": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

collectionId
string
required

The ID of the issue collection Collection ID

Example:

"123"

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 50
cursor
string

Cursor for pagination. Use the nextCursor value from a previous response.

since
string

ISO 8601 datetime. Only return sessions with issues after this time. Defaults to 24 hours ago.

until
string

ISO 8601 datetime. Only return sessions with issues before this time. Defaults to now.

include
string

Comma-separated list of optional fields to include: timeline, clicks, screenshots. Requesting screenshots automatically includes clicks.

Example:

"timeline,clicks"

Response

Paginated list of collection sessions

object
enum<string>
required
Available options:
list
collection
object
required
data
object[]
required
includes
enum<string>[]
required

Which optional fields were included in the request

Available options:
timeline,
clicks,
screenshots
hasMore
boolean
required
nextCursor
string | null
required
window
object
required
screenshotsExpiresAt
string | null

ISO timestamp when included screenshot URLs expire (~3h). Null when no screenshot URLs are present.