1. Home
  2. Limnu API
  3. Function: boardActive

Function: boardActive

Overview

boardActive returns a list of users that are currently connected to a given board.

Parameters

Input parameters:

  1. apiKey: Private API key issued by Limnu to developers.
  2. boardId: The boardId of the board you wish to examine, as issued by boardCreate.

Response attribute details: users

users contains the list of all users that are currently connected to the board in the input parameters. Each user record contains the number of seconds the user has been connected to the board (ie: since the last time the page was loaded).

There may be a delay of a few seconds after a user disconnects from a board before the results of boardActive are updated.

The data is structured like this:

"users":{

"U_8jksmRr4bqmjPl":{"seconds":3280},

"U_ARSfi7vp5pxSCC":{"seconds":3100}

}

Example data

Example of correct JSON input:

{

"apiKey": "K_isR4E6qcQamY0NxFuKa9aw7k5hssRBQXuqpStgR1qU1A",

"boardId": "B_B7LyhbF2QGaCV4",

}

Example of JSON output from a successful call:

{

"success": true,

"users":{

"U_8jksmRr4bqmjPl":{"seconds":3280},

"U_ARSfi7vp5pxSCC":{"seconds":3100}

}

}

Example of JSON output from a failed call:

{

"success": false,

"reason": "No such board: B_B7LyhbF2QGaCV4"

}

Command Line Testing

Here’s an example of how to test boardActive from the command line:

curl \

https://api.limnu.com/v1/boardActive \

--request POST \

--header "Content-Type: application/json" \

--data @boardActive.json

The contents of the file named boardActive.json are:

{

"apiKey": "K_isR4E6qcQamY0NxFuKa9aw7k5hssRBQXuqpStgR1qU1A",

"boardId": "B_B7LyhbF2QGaCV4"

}