documentation

Patient Vault v3 API

Custom Fields / Statistics / Apps

/v3/custom-data/statistics/apps endpoint reference.

URL: https://demo.1health.io/api/v3/custom-data/statistics/apps

No description available in the API specification.

Endpoints

EndpointMethodDescription
/v3/custom-data/statistics/appsPOSTGet custom data counts per application

POST/v3/custom-data/statistics/apps

Get custom data counts per application

Overview

Returns custom data counts — definition count, field count and row count — for each of the requested applications, for rendering per-app badges on the studio's app cards and sidebar in a single call.

Authorization

Bearer JWT required. See the authentication guide.

Request Body

Content-Type: application/json · DTO: AppCustomDataStatsRequestDTO

{
  "appIds": "example-value",
  "hasDefinitionsOnly": true
}
FieldTypeRequiredConstraintsDescription
appIdsarrayYesThe external application IDs to return counts for.
hasDefinitionsOnlybooleanNoWhen true, applications with no custom data definitions are omitted from the result.

Responses

200 OK

Per-application custom data counts retrieved successfully.

DTO: AppCustomDataStatsDTO

[
  {
    "appId": 1001,
    "definitionCount": 1001,
    "fieldCount": 1001,
    "rowCount": 1001
  }
]
FieldTypeNullableDescription
appIdLongNoThe external application ID.
definitionCountlongNoNumber of custom data definitions the application has.
fieldCountlongNoTotal number of custom fields across the application's definitions.
rowCountlongNoNumber of custom_data rows for the application across all tenants.

401 Unauthorized

Not authenticated — valid session required.

Example

curl -X POST "https://demo.1health.io/api/v3/custom-data/statistics/apps" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" -d '{"appIds": "example-value", "hasDefinitionsOnly": true}'

Parent: https://agents.1health.io/public/demo/api/v3/custom-data/statistics/agents.md · Site guide: https://agents.1health.io/public/demo/api/agents.md