Open in ChatGPT
View as Markdown

List LMS users correlated with sessions

GET /v1/users
Base URL 
https://api.isnotai.com
Available Regions 2 regions

Query Parameters

pageSize
integer(int32)

Page size. The maximum is scoped to the integration’s plan tier (Free 50, Pro and Enterprise 100). Requests above the tier maximum clamp to the maximum and the effective value is returned in pagination.limit. Minimum 1. Default 50.

cursor
string

Opaque continuation cursor returned by a previous call.

search
string

Case-insensitive substring match against userId or userName.

Responses

200 application/json

Payload of UserListResponse

Show 2 response attributes Hide response attributes
data
array[object]
Show 13 data attributes Hide data attributes
userId
string
userName
string
sessionCount
integer(int32)
botSessionCount
integer(int32)
mediumSessionCount
integer(int32)
averageBotScore
number(double)
maxBotScore
number(double)
deviceCount
integer(int32)
firstSeen
string(date-time)
lastSeen
string(date-time)
riskLevel
string
sparkline
array[integer(int32)]
userUrl
string
pagination
object
Show 3 pagination attributes Hide pagination attributes
nextCursor
string
hasMore
boolean
limit
integer(int32)
401 application/json

Payload of ErrorEnvelope

Show 1 response attribute Hide response attributes
error
object
Show 3 error attributes Hide error attributes
code
string
message
string
details
object
GET /v1/users 
curl --request GET \
  --url https://api.isnotai.com/v1/users \
  --header 'Authorization: Bearer aik_v1_YOUR_API_KEY'
import requests

url = "https://api.isnotai.com/v1/users"

headers = {"Authorization": "Bearer aik_v1_YOUR_API_KEY"}

response = requests.get(url, headers=headers)

print(response.json())
const fetch = require('node-fetch');

const url = 'https://api.isnotai.com/v1/users';
const options = {method: 'GET', headers: {Authorization: 'Bearer aik_v1_YOUR_API_KEY'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.isnotai.com/v1/users"),
    Headers =
    {
        { "Authorization", "Bearer aik_v1_YOUR_API_KEY" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

Try it

Collapse

Sent to the API as Authorization: Bearer aik_v1_.... Held only in this tab's input element; re-enter on each browser tab. The docs site never receives or stores it.

Query parameters

Page size. The maximum is scoped to the integration's plan tier (Free 50, Pro and Enterprise 100). Requests above the tier maximum clamp to the maximum and the effective value is returned in pagination.limit. Minimum 1. Default 50.

Opaque continuation cursor returned by a previous call.

Case-insensitive substring match against userId or userName.

200 Response examples 
{
  "data": [
    {
      "userId": "string",
      "userName": "string",
      "sessionCount": 0,
      "botSessionCount": 0,
      "mediumSessionCount": 0,
      "averageBotScore": 0,
      "maxBotScore": 0,
      "deviceCount": 0,
      "firstSeen": "2024-01-01T00:00:00Z",
      "lastSeen": "2024-01-01T00:00:00Z",
      "riskLevel": "string",
      "sparkline": [
        0
      ],
      "userUrl": "string"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "hasMore": false,
    "limit": 0
  }
}
401 Response examples 
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}