Skip to main content
GET
Generate Entity Status Report

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Path Parameters

program_id
string
required

Program ID for which to generate the report

Query Parameters

status
string

Status to filter by (e.g., 'dropped out', 'continuing')

year
string

Year to filter by (e.g., '2024')

field_key
string

Field key to filter by (e.g., 'gender')

field_value
string

Field value to filter by

Response

Report generated successfully

data
object[]
summary
object