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/v10/reports/ReportName

Get report data

Retrieve the report contents as CSV data. Use the HEAD method to see the size of the CSV data and decide if it is worth downloading it.

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

Parameters

Each report requires a different set of parameters. If any one of them is not properly set, this API request will return an error and list the unset parameters. Use this functionality to learn which parameters are required for specific reports.

Parameter	Required/Optional	Description	Notes
`commenceYear`	See above	The year number representing the intake season to use
`comparedYear`	See above	Same as above, used for reports that compare two seasons
`institutions`	See above	A list of institution IDs	Lists can be either comma or space separated
`courses`	See above	A list of course IDs	Lists can be either comma or space separated
`regions`	See above	A 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/v10/reports/ReportTrackersApplicantDetails?institutions=1&calendarYear=2025&intakes=27&citizenships=US,UK"

Response headers

Header	Value	Description
`Content-Type`	`text/csv; charset=utf-8`	The media type of the resource
`Content-Length`	`12345`	The 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`	The date and time when the report was last modified
`Expires`	`Tue, 01 Jul 2014 16:53:36 GMT`	The report expiration date and time

The Expires and Last-Modified headers can be used to fetch a fresh data copy. If a new request is issued before Expires, 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