curl --request POST \
--url https://pria.praxislxp.com/api/user/uploads/vault-health-summary \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institution": "<string>"
}
'import requests
url = "https://pria.praxislxp.com/api/user/uploads/vault-health-summary"
payload = { "institution": "<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({institution: '<string>'})
};
fetch('https://pria.praxislxp.com/api/user/uploads/vault-health-summary', 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/user/uploads/vault-health-summary",
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([
'institution' => '<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/user/uploads/vault-health-summary"
payload := strings.NewReader("{\n \"institution\": \"<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/user/uploads/vault-health-summary")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"institution\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/uploads/vault-health-summary")
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 \"institution\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"summary": {
"totalCount": 123,
"activeCount": 123,
"errorCount": 123,
"neverUsedCount": 123,
"staleCount": 123,
"unscannedCount": 123,
"unoptimizedCount": 123,
"unindexedCount": 123,
"missingTerminalCount": 123,
"staleBaseUrlCount": 123
},
"grade": {
"letter": "B",
"score": 84.6,
"factors": [
{
"key": "unindexedCount",
"count": 12,
"impact": 5.4,
"label": "Included but no segments indexed"
}
]
}
}Aggregate vault-wide health stats
Returns per-category counts across the entire vault (Personal / Instance / Account) — not scoped to the current collection or page. Used by the Files panel’s Vault Health header to compute the A-F grade and the attention dot. Computed via parallel $match + $count pipelines (DocumentDB-safe; no $facet).
curl --request POST \
--url https://pria.praxislxp.com/api/user/uploads/vault-health-summary \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institution": "<string>"
}
'import requests
url = "https://pria.praxislxp.com/api/user/uploads/vault-health-summary"
payload = { "institution": "<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({institution: '<string>'})
};
fetch('https://pria.praxislxp.com/api/user/uploads/vault-health-summary', 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/user/uploads/vault-health-summary",
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([
'institution' => '<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/user/uploads/vault-health-summary"
payload := strings.NewReader("{\n \"institution\": \"<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/user/uploads/vault-health-summary")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"institution\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/uploads/vault-health-summary")
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 \"institution\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"summary": {
"totalCount": 123,
"activeCount": 123,
"errorCount": 123,
"neverUsedCount": 123,
"staleCount": 123,
"unscannedCount": 123,
"unoptimizedCount": 123,
"unindexedCount": 123,
"missingTerminalCount": 123,
"staleBaseUrlCount": 123
},
"grade": {
"letter": "B",
"score": 84.6,
"factors": [
{
"key": "unindexedCount",
"count": 12,
"impact": 5.4,
"label": "Included but no segments indexed"
}
]
}
}Authorizations
JWT token passed in x-access-token header
Body
Response
Summary returned
true
Show child attributes
Show child attributes
Composite vault-health grade derived from the summary counts. Lets API consumers (UI, dashboards) display a single A–F letter + 0–100 score without re-implementing the rules client-side.
Severity weights per category (penalty per 100% of total):
- Critical (50pts): errorCount, unindexedCount, missingTerminalCount
- Degraded (25pts): unoptimizedCount, staleBaseUrlCount
- Stale (10pts): neverUsedCount, staleCount
- Unknown (5pts): unscannedCount
score = 100 − Σ (weight × count / totalCount), clamped to ≥0.
Letter: 90+ A, 80+ B, 70+ C, 60+ D, else F. Empty vault returns
{ letter: 'N/A', score: null, factors: [] }.
Show child attributes
Show child attributes
Was this page helpful?