Report

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

Represents a single report.

URI
/api/v9/reports/ReportName

Get report data

The report’s contents as CSV data. You may use the HEAD verb to see the size of the CSV data if you want to decide if it is worth downloading it.

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

Parameters

Each report will require a different set of parameters. If any one of them is not properly set, an error will be returned, listing the unset parameters. Use this functionality to learn which report will require which parameter.

Parameter	Required/Optional	Description	Notes
`commenceYear`	See above	Year number, representing the intake season to use
`comparedYear`	See above	Same as above, used for reports that compare two seasons
`institutions`	See above	List of institution IDs	Lists can be either comma or space separated
`courses`	See above	List of course IDs	Lists can be either comma or space separated
`regions`	See above	List of region IDs	Lists can be either comma or space separated

Example request

Request
curl
curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/reports/ReportTrackersApplicantDetails?institutions=1&calendarYear=2025&intakes=27&citizenships=US,UK"

Response headers

Header	Value	Description
`Content-Type`	`text/csv; charset=utf-8`	Media type of the resource
`Content-Length`	`12345`	Size of the response body in bytes
`Content-Disposition`	`attachment; filename="Registrations-2014-02-12T15:19:21+00:00.csv`	Information on how to process the response payload, for example, a suggested filename for downloads
`Last-Modified`	`Tue, 01 Jul 2014 16:35:19 GMT`	Date and time when the report was last modified
`Expires`	`Tue, 01 Jul 2014 16:53:36 GMT`	Report expiration date and time

The Expires and Last-Modified headers can be used to assess the need to fetch a fresh copy of the data. If a new request is issued before Expires, then the same data is guaranteed to be returned, hence making such unintelligent polling useless.

Response codes

Response code	Description
`200 OK`	The report data was successfully returned
`400 Bad Request`	The required parameters are missing, see the error description
`404 Not Found`	The report does not exist

Reports

Scoresheets