Get a session

Request

Get details on a specific session.

Security

ApiKey(Required scopes: sessions.list)

Path

keyOrIdstringrequired

Recording Session Key or ID

Query

projectIdstring

Filter sessions by project. Required for multi-project orgs.

Payload

// No request payload

Responses

Success

Bodyapplication/json

idstringrequired

ID of the recording session

projectIdstringrequired

The project ID that the session belongs to

deviceobject(DeviceSummary)required

ID and name of a device.

keystring

A user-supplied identifier, unique within the project.

createdAtstring, (date-time)required

Timestamp when the session was created.

updatedAtstring, (date-time)required

Timestamp when the session was last updated.

propertiesobject(CustomPropertyValues)

A key-value map of the custom properties associated with this session.

recordingsArray of objectsrequired

Recordings associated with this session.

Response

{
  "id": "string",
  "projectId": "string",
  "device": {
    "id": "string",
    "name": "string"
  },
  "key": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": "string",
    "property2": "string"
  },
  "recordings": [
    { … }
  ]
}