Skip to main content

DeviceSessionsOut

Response for listing device sessions.

sessions object[]required
  • Array [
    • idstring<uuid>required
    started_atstring<date-time>required
    ended_at object
    anyOf
    string<date-time>
    duration_seconds object
    anyOf
    integer
    location_countLocation Count (integer)required
    distance_meters object
    anyOf
    number
    has_track_geometryHas Track Geometry (boolean)
    Default value: false
    auto_closed_at object
    anyOf
    string<date-time>
    close_reasonClose Reason (string)
    Default value:
    auto_closed_from_shift_status object
    anyOf
    string
    photo_count objectrequired

    Session photos; null for an API key without storage:read.

    anyOf
    integer
    note_count objectrequired

    Session notes; null for an API key without devices:read.

    anyOf
    integer
  • ]
    • total_countTotal Count (integer)required
    open_session object

    The open session of an active or paused shift. Only with include_open=true; never counted in sessions or total_count.

    anyOf
    idstring<uuid>required
    started_atstring<date-time>required
    ended_at object
    anyOf
    string<date-time>
    duration_seconds object
    anyOf
    integer
    location_countLocation Count (integer)required
    distance_meters object
    anyOf
    number
    has_track_geometryHas Track Geometry (boolean)
    Default value: false
    auto_closed_at object
    anyOf
    string<date-time>
    close_reasonClose Reason (string)
    Default value:
    auto_closed_from_shift_status object
    anyOf
    string
    photo_count objectrequired

    Session photos; null for an API key without storage:read.

    anyOf
    integer
    note_count objectrequired

    Session notes; null for an API key without devices:read.

    anyOf
    integer
    DeviceSessionsOut
    {
      "sessions": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "started_at": "2024-07-29T15:51:28.071Z",
          "ended_at": "2024-07-29T15:51:28.071Z",
          "duration_seconds": 0,
          "location_count": 0,
          "distance_meters": 0,
          "has_track_geometry": false,
          "auto_closed_at": "2024-07-29T15:51:28.071Z",
          "close_reason": "",
          "auto_closed_from_shift_status": "string",
          "photo_count": 0,
          "note_count": 0
        }
      ],
      "total_count": 0,
      "open_session": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "started_at": "2024-07-29T15:51:28.071Z",
        "ended_at": "2024-07-29T15:51:28.071Z",
        "duration_seconds": 0,
        "location_count": 0,
        "distance_meters": 0,
        "has_track_geometry": false,
        "auto_closed_at": "2024-07-29T15:51:28.071Z",
        "close_reason": "",
        "auto_closed_from_shift_status": "string",
        "photo_count": 0,
        "note_count": 0
      }
    }