Skip to main content
POST
Get User Sessions

Get User Sessions

Retrieve user session data with filtering and pagination options.

Endpoint

Headers

Note: The publisher-authentication-key header corresponds to your Secret Key. The authorizationKey in the request body corresponds to your Web API Key.

Request Body

Request Body Parameters

Response

Error Response

Authorizations

publisher-authentication-key
string
header
required

Send your Secret Key using the publisher-authentication-key header. This header is required for every request.

Body

application/json

Payload for retrieving user sessions. Includes your Web API Key plus optional filtering criteria.

authorizationKey
string
required

Publisher's project web API key

Example:

"DqcInvhIFAl5WtUNwihFUIgUH77EL2hTNRU"

rows
integer
default:100

Number of records per page. Min: 1, Max: 500.

Required range: 1 <= x <= 500
Example:

100

page
integer
default:1

The page number for pagination.

Required range: x >= 1
Example:

1

sessionType
enum<integer>
default:0

0 = Live, 1 = Test.

Available options:
0,
1
Example:

0

status
enum<string>
default:all

Session status filter

Available options:
all,
completed,
overquota,
terminated,
securityDrop,
prescreen
Example:

"completed"

startDate
string<date>

ISO Date format (YYYY-MM-DD). Defaults to 30 days ago.

Example:

"2025-11-24"

endDate
string<date>

ISO Date format (YYYY-MM-DD). Defaults to current date.

Example:

"2025-12-24"

Response

Successful response with user sessions data

success
boolean
required
Example:

true

message
string
required
Example:

"User sessions fetched successfully"

data
object[]
required
pagination
object
required
organisation
string
Example:

"Organisation Name"

project
string
Example:

"Project Name"