Usage-vs-cap reporting (per-user) or account-wide at-limit counts.
curl --request GET \
--url https://pria.praxislxp.com/api/admin/usage-limits \
--header 'Authorization: Bearer <token>'import requests
url = "https://pria.praxislxp.com/api/admin/usage-limits"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://pria.praxislxp.com/api/admin/usage-limits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/admin/usage-limits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/usage-limits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pria.praxislxp.com/api/admin/usage-limits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/usage-limits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"capsEnabled": true,
"accountWide": {
"used": 123,
"cap": 123,
"over": true
},
"perInstitution": {
"used": 123,
"cap": 123,
"over": true
},
"h24": {
"used": 123,
"cap": 123,
"over": true
},
"buckets": [
{
"start": "<string>",
"credits": 123,
"messages": 123
}
],
"totals": {
"credits": 123,
"messages": 123
}
}Admin Usage Limits
Usage-vs-cap reporting (per-user) or account-wide at-limit counts.
Two modes selected by query parameters:
userId+institutionId(orinstanceIdalias): one user’s usage-vs-cap gauges plus over-time{buckets, totals}(same shape as the user usage chart).accountId: account-wide counts of users/memberships at or over a cap.
Per-user mode needs the users.edit entitlement on the Digital Twin asked
about, which must be the twin the person is reached through (their current
twin, or yours when they joined it themselves). Account mode needs the
institutions.edit entitlement on one of the account’s Digital Twins.
GET
/
api
/
admin
/
usage-limits
Usage-vs-cap reporting (per-user) or account-wide at-limit counts.
curl --request GET \
--url https://pria.praxislxp.com/api/admin/usage-limits \
--header 'Authorization: Bearer <token>'import requests
url = "https://pria.praxislxp.com/api/admin/usage-limits"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://pria.praxislxp.com/api/admin/usage-limits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/admin/usage-limits",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/usage-limits"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pria.praxislxp.com/api/admin/usage-limits")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/usage-limits")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"capsEnabled": true,
"accountWide": {
"used": 123,
"cap": 123,
"over": true
},
"perInstitution": {
"used": 123,
"cap": 123,
"over": true
},
"h24": {
"used": 123,
"cap": 123,
"over": true
},
"buckets": [
{
"start": "<string>",
"credits": 123,
"messages": 123
}
],
"totals": {
"credits": 123,
"messages": 123
}
}Authorizations
JWT token passed in authorization header
Query Parameters
Target user id (per-user mode; requires institutionId/instanceId).
Institution id for the per-user mode.
Alias for institutionId (forwarded by the usage chart).
Over-time window in days (per-user mode).
Account id (account-wide at-limit mode).
Was this page helpful?