Reports
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a list of all available reports.
URI
/api/v9/reportsView all API requests
| API request | Return Type | Verb | Description |
|---|---|---|---|
/api/v9/reports | C | GET, HEAD | List all available reports |
/api/v9/reports/ReportName | R | GET, HEAD | Request data from a specific report |
GET List reports
List report names that are available via the API.
Syntax
GET /api/v9/reports
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/reports"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
X-Count | 15 | Number of available reports |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of reports was successfully returned |
Example response
Response
[
"ReportTrackers",
"ReportTrackersApplicantDetails",
"ReportApplicantRegistrations",
"ReportApplicationLastRevised",
"ReportApplicationRevisions",
"ReportDocumentUploads",
"ReportStatus",
"ReportStatusByCitizenship",
"ReportStatusByInstitutionAll",
"ReportStatusByInstitutionTop1",
"ReportStatusByInstitutionTop3",
"ReportSizeByStatus",
"ReportInvoices",
"ReportStatusByCourseAdmin",
"ReportStatusByCourseApplicant",
"ReportStatusByCitizenshipAdmin",
"ReportStatusByCitizenshipApplicant",
"ReportApplicationsMatrix",
"ReportOffersMatrix",
"ReportApplicationsFunnelMonthly",
"ReportApplicationsFunnelWeekly",
"ReportApplicationsPriorities",
"ReportInvoicesDetails"
]