Sessions

Get sessions

get

Gets sessions. Query parameters can be used for filtering sessions.

Authorizations

jwtapiToken

Query parameters

pageintegerOptional

The page number of results

Example: 1

limitintegerOptional

The number of results to return per page

Default: 50Example: 100

startDatestring · dateRequired

The start date of the report (UTC time & inclusive).

Default: 12 months prior to todayExample: 2023-01-01

endDatestring · dateOptional

The end date of the report (UTC time & inclusive).

Default: todayExample: 2023-02-01

searchstringOptional

Text search for sessions. Can be build id, app id, app name, etc.

Example: wikipedia

targetIdstringOptional

Only include sessions for this target ID

Example: b_k5h7avnbeedjbkm2cwuorlis7m

appIdstringOptional

Only include sessions for this App ID

Example: com.myorg.myapp

bundlestringOptional

Only include sessions for this bundle

Example: com.myorg.myapp

buildTagsstringOptional

Only include builds with these tags

Example: dev,qa

buildVersionNamestringOptional

Only include builds with this version name

Example: v1.2.3

devicestringOptional

Only include sessions that used this device

Example: iphone15pro

platformstring · enumOptional

Only include sessions for this platform

Example: iosPossible values:

osVersionstringOptional

Only include sessions that used this osVersion. Can be specific version or just major.

Example: 18

usersstringOptional

Only include sessions from these users. Must be admin role, otherwise this will always be yourself.

Example: [e-mail],[e-mail]

sessionTokenstringOptional

Find the session by token

Example: 790a2c1c0e19725323ab0a337478c3d22464536760b5b3f1ad39ec57472a5842

sortstring · enumOptional

Sort sessions by this field

Default: startTimeExample: startTimePossible values:

orderstring · enumOptional

Order the sort by ascending or descending

Default: descExample: ascPossible values:

Responses

200

OK

application/jsontext/csv

totalinteger · int32OptionalExample: 25

nextPagenumber · int32 · nullableOptionalExample: 2

400

Invalid query parameters

application/json

403

Forbidden

application/json

406

Unsupported Accept header

application/json

get/v2/sessions

HTTPcURLJavaScriptPython

GET /v2/sessions?startDate=12+months+prior+to+today HTTP/1.1
Host: api.appetize.io
Accept: */*

{
  "results": [
    {
      "targetId": "b_f7zjgmmchdbr6htrpfsr6o4iky",
      "sessionRequestedTime": "2023-10-12 15:26:25.499",
      "startTime": "2023-10-12 15:26:25.511",
      "userConnectedTime": "2023-10-12 15:26:25.939",
      "frameTime": "2023-10-12 15:26:30.533",
      "appLaunchTime": "2023-10-12 15:26:30.377",
      "endTime": "2023-10-12 15:27:38.845",
      "closeTime": "2023-10-12 15:27:49.345",
      "sessionLengthSeconds": 83.834,
      "referrer": "https://appetize.io/app/f7zjgmmchdbr6htrpfsr6o4iky?device=pixel4&osVersion=11.0&scale=75",
      "referrerHostname": "appetize.io",
      "sessionToken": "f61ad58ab600579080fafb966e852134c2e9153e8d8c9a90269301d35cb80a1f",
      "clientLanguage": "en-US,en;q=0.9,fr;q=0.8",
      "clientUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36",
      "versionCode": 1,
      "device": "pixel4",
      "osVersion": "11.0",
      "rotation": 0,
      "debug": false,
      "warmSession": false,
      "queued": false,
      "noVideo": false,
      "location": [],
      "user": "[e-mail]",
      "queueTimeSeconds": 20,
      "params": {
        "key": "value"
      },
      "target": {
        "id": "b_fa5ir5rcrlwxc7oy3ezglorv2u",
        "versionCode": "1",
        "appId": "com.example.helloworld",
        "bundle": "com.example.helloworld",
        "name": "Hello World",
        "versionName": "1.0",
      }
    }
  ],
  "total": 100,
  "nextPage": 2
}

Get session attachment

get

Gets a session attachment

Authorizations

jwtapiToken

Path parameters

sessionTokenstringRequired

The session token of the session to get the attachment for

Example: 790a2c1c0e19725323ab0a337478c3d22464536760b5b3f1ad39ec57472a5842

Query parameters

typestring · enumRequired

The type of attachment to get

Example: network-capturesPossible values:

Responses

307

Redirect to the attachment file

403

Forbidden

application/json

404

Session not found

application/json

get/v2/sessions/{sessionToken}/attachment

HTTPcURLJavaScriptPython

GET /v2/sessions/{sessionToken}/attachment?type=network-captures HTTP/1.1
Host: api.appetize.io
Accept: */*

No content