meta data for this page

/api/reports

HEAD, GET

List report names that are available via the API. The number of reports is represented in the X-Count header - use the HEAD request to simply count the number of reports available. Use the GET request to actually fetch the list of report names.

Syntax

GET /api/reports
Host: apply.example.edu
Authorization: DREAM apikey="..."

Response headers

Content-Type: application/json
Content-Length: 1234
X-Count: 15

Response example

[
  "ReportTrackers",
  "ReportTrackersApplicantDetails",
  "ReportApplicantRegistrations",
  "ReportApplicantRegistrationsByRegion",
  "ReportApplicationLastRevised",
  "ReportApplicationRevisions",
  "ReportDocumentUploads",
  "ReportDocumentUploadsByRegion",
  "ReportStatus",
  "ReportStatusByRegion",
  "ReportStatusByInstitutionAll",
  "ReportStatusByInstitutionTop1",
  "ReportStatusByInstitutionTop3",
  "ReportSizeByStatus",
  "ReportInvoices",
  "ReportFeedbacks",
  "ReportStatusByCourseAdmin",
  "ReportStatusByCourseApplicant",
  "ReportStatusByRegionAdmin",
  "ReportStatusByRegionApplicant",
  "ReportApplicationsMatrix",
  "ReportOffersMatrix",
  "ReportApplicationsFunnelMonthly",
  "ReportApplicationsFunnelWeekly",
  "ReportApplicationsFunnel",
  "ReportApplicationsPriorities",
  "ReportTimeSpentPerStudent",
  "ReportTimeSpentPerStudentAnonymous",
  "ReportTimeSpentPerInstitution"
]