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

Function: boardUsage

Overview

boardUsage returns a list of users that have used a board, and how much time they’ve spent on the board.

If you are on a payment model that is calculated per-board, the data that this function samples from is what Limnu uses to calculate your costs. If a board is used across payment boundaries and as such has partially billing in multiple months, that is not represented in the output of this function.

Parameters

Input parameters:

  • apiKey: Private API key issued by Limnu to developers.
  • 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 have used the board in the input parameters. Each user contains the number of times the user has connected to the board, along with the total number of seconds the user has spent connected to the board. The data is structured like this:

"users":{

"U_8jksmRr4bqmjPl":{"connectionCount":2,"secondsUsed":3280},

"U_ARSfi7vp5pxSCC":{"connectionCount":3,"secondsUsed":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":{"connectionCount":2,"secondsUsed":3280},

"U_ARSfi7vp5pxSCC":{"connectionCount":3,"secondsUsed":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 boardUsage from the command line:

curl \

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

--request POST \

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

--data @boardUsage.json

 

The contents of the file named boardUsage.json are:

{

"apiKey": "K_isR4E6qcQamY0NxFuKa9aw7k5hssRBQXuqpStgR1qU1A",

"boardId": "B_B7LyhbF2QGaCV4"

}