realtimeAnalytics

Check presence status for users

Returns online status for specified user IDs

POST/api/realtime/projects/{projectId}/presence

Authentication

Requires JWT

Note

Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

Name	Type	Required	Description
`projectId`	string	Yes	Project ID.

Request Body

Array of user IDs to check presence for.

json

{
  "userIds": [
    "685acbe0e129932fbb7a0fc2",
    "685acbe0e129932fbb7a0fc3"
  ]
}
{
  "userIds": [
    "685acbe0e129932fbb7a0fc2",
    "685acbe0e129932fbb7a0fc3"
  ]
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.realtimeAnalytics.checkUserPresence({
  projectId: "usr_sZAeZLCXFnAzjs",
  userIds: "system override"
});
const result = await client.realtimeAnalytics.checkUserPresence({
  projectId: "usr_sZAeZLCXFnAzjs",
  userIds: "system override"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Path Parameters

projectId

Request Body (JSON)

No Request Yet

Send a request to see the full inspector

Responses

200Presence status for each user

json

{
  "presence": {},
  "timestamp": "2024-01-15T10:00:00.000Z"
}
{
  "presence": {},
  "timestamp": "2024-01-15T10:00:00.000Z"
}

400Bad request or validation error.

401Authentication required or invalid token.

404Project not found (exact backend message).

Errors

Code	Meaning
`400`	Bad request or validation error.
`401`	Authentication required or invalid token.
`404`	Project not found (exact backend message).

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub