curl --request POST \
--url https://pria.praxislxp.com/api/admin/users/cap-effectiveness \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"account": "<string>",
"institution": "<string>",
"usersearch": "<string>",
"accountType": "<string>"
}
'import requests
url = "https://pria.praxislxp.com/api/admin/users/cap-effectiveness"
payload = {
"account": "<string>",
"institution": "<string>",
"usersearch": "<string>",
"accountType": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: '<string>',
institution: '<string>',
usersearch: '<string>',
accountType: '<string>'
})
};
fetch('https://pria.praxislxp.com/api/admin/users/cap-effectiveness', 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/users/cap-effectiveness",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account' => '<string>',
'institution' => '<string>',
'usersearch' => '<string>',
'accountType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/users/cap-effectiveness"
payload := strings.NewReader("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"accountType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/admin/users/cap-effectiveness")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"accountType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/users/cap-effectiveness")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"accountType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"institutionId": "<string>",
"institutionName": "<string>",
"account": "<string>",
"cap": 123,
"members": 123,
"reached": 123,
"under": 123,
"reachedPct": 123
}
],
"totals": {
"institutions": 123,
"members": 123,
"reached": 123,
"reachedPct": 123
},
"generatedAt": "2023-11-07T05:31:56Z"
}Live 24h cap-effectiveness analytics
For every institution in the caller’s scope that has an ACTIVE per-user 24-hour credit cap, reports how many members are at/over their cap right now (reached) versus under it. Scope is resolved exactly like the user list (institution → account → the institutions the caller administers). Usage is the pooled 24h credit sum per member; members with no recorded pooled usage count as under the cap.
curl --request POST \
--url https://pria.praxislxp.com/api/admin/users/cap-effectiveness \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"account": "<string>",
"institution": "<string>",
"usersearch": "<string>",
"accountType": "<string>"
}
'import requests
url = "https://pria.praxislxp.com/api/admin/users/cap-effectiveness"
payload = {
"account": "<string>",
"institution": "<string>",
"usersearch": "<string>",
"accountType": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
account: '<string>',
institution: '<string>',
usersearch: '<string>',
accountType: '<string>'
})
};
fetch('https://pria.praxislxp.com/api/admin/users/cap-effectiveness', 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/users/cap-effectiveness",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'account' => '<string>',
'institution' => '<string>',
'usersearch' => '<string>',
'accountType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/admin/users/cap-effectiveness"
payload := strings.NewReader("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"accountType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://pria.praxislxp.com/api/admin/users/cap-effectiveness")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"accountType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/users/cap-effectiveness")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account\": \"<string>\",\n \"institution\": \"<string>\",\n \"usersearch\": \"<string>\",\n \"accountType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": [
{
"institutionId": "<string>",
"institutionName": "<string>",
"account": "<string>",
"cap": 123,
"members": 123,
"reached": 123,
"under": 123,
"reachedPct": 123
}
],
"totals": {
"institutions": 123,
"members": 123,
"reached": 123,
"reachedPct": 123
},
"generatedAt": "2023-11-07T05:31:56Z"
}Authorizations
JWT token passed in x-access-token header
Body
Space-separated account id(s) to scope to.
Space-separated institution id(s) to scope to (takes precedence over account).
Case-insensitive substring matched against member email / first / last name to narrow the membership tally.
Restrict the membership tally to members with this account type.
Was this page helpful?