The sessions() GraphQL query provides paginated search results for tokens.

For information on session management, see the Session Management documentation page. You may also want to look at session().

Syntax

Below is the syntax for the sessions() query field:

graphql
sessions(
      searchFilter: string
      level: Sessions__Filter_Level = Organization
      sortBy: Sessions__SortBy = LastActivityTime
      orderBy: OrderBy = ASC
      skip: Int = 0
      limit: Int = 50
      onlyActiveSessions: boolean = true
   ): SessionQueryResultSet!

Returned Datatypes

The returned datatype SessionQueryResultSet has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SessionQueryResultSet

ParameterTypeRequired[a]DefaultDescription
totalResultsintegeryes The total number of matching results.
results[Session]yes The paginated results set (see Session Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.