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>"
}
'{
"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>"
}
'{
"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?