Connect

Operations to query visitor user session data

GET: Query User Sessions

Description

Query user session data based on the filter criteria. The results are sorted by last login time in descending order. The search can be performed on MAC addresses, last session time, status, and any or all fields. The query is paged using index and count parameters with maximum size in 1000. The returned JSON object includes the number of records returned and next index to query if more. You can also download the queried result in CSV file with URL /api/connect/v1/clients/export. The export query does not have maximum size limit.

HTTP Method

GET

Resource URI

/api/connect/v1/clients

Requires OAuth

N

Parameters

Table 1. Parameter Details

Name

Required

Default

Type

Location

Description

start

N

—

String

query

Session start time based on last login time in UTC epoch format. Use the Epoch Convertor. https://www.epochconverter.com/

end

N

—

String

query

Session end time based on last login time in UTC epoch format. Use the Epoch Convertor. https://www.epochconverter.com/

index

N

—

String

query

Starting index of the query based on 0.

count

N

—

String

query

Number of records to query with the limit of 1000 at maximum.

status

N

—

String

query

Status of the users. Allowed: all,active.

authtype

N

—

String

query

Authentication type used by the user. Allowed values/formats:registration, SMS, social.

mac

N

—

String

query

MAC address in 00:11:22:33:44:55:66 format. If MAC address is used, all other parameters will be ignored.

device

N

—

String

query

Type of user's device.

os

N

—

String

query

Operating system of user's device.

language

N

—

String

query

Language served to the user. It can search by full language name or two-letter language code.

all

N

—

String

query

The search applies to all fields.

Content Type

application/json

Sample Input (JSON)

10.122.141.178/api/connect/v1/clients?start=1534108572&end=2534108572

Sample Output (JSON)


{
    "nextIndex": 0,
    "timeZoneOffset": -14400000,
    "queryRecordCount": 1000,
    "timeZone": "Eastern Standard Time",
    "records": [],
    "returnRecordCount": 0
}