Gets a summary of all the users, devices, user sessions, and session times of an org

  • Published on Jul 21, 2025
  • 1 minute(s) read
Prev Next
Get
/api/v1/summary
Security
HTTP
Type bearer
Query parameters
to
string

The most recent date to search until

from
string

The earliest date to search from

periodicity
string

An interval of time

Examplemonth
timezone
string
ExampleAsia/Kolkata
formatter
string
Exampleotaui
Responses
200

OK

Expand All
object
authorization
boolean
data
Array of object
object
ouDevices
Array of object (OUDevicesUsersSummary)
object
graphData
object
Example{}
totalCount
integer
totalUniqueCount
integer
ouUsers
Array of object (OUDevicesUsersSummary)
object
graphData
object
Example{}
totalCount
integer
totalUniqueCount
integer
sessionTimes
object (SummarySession)
count
integer
countInSeconds
integer
graphData
object
Example{}
period
string
periodicity
string
userSessions
object (SummarySession)
count
integer
countInSeconds
integer
graphData
object
Example{}
period
string
periodicity
string
error_code
integer
error_message
string
error_status
boolean
Examplefalse
500

Internal Server Error

object
authorization
boolean
data
Array of string
Example[]
string
error_code
integer | null
error_message
string | null
error_status
boolean