Trackers (global)
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 trackers configured in DreamApply. For a list of trackers assigned to a specific applicant, see Trackers.
URI
/api/v10/applicants/trackersGET List trackers
List all trackers configured in DreamApply.
Syntax
GET /api/v10/applicants/trackers
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/v10/applicants/trackers"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 1456 | The size of the response body in bytes |
X-Count | 2 | The number of returned trackers |
Response codes
| Response code | Description |
|---|---|
200 OK | The list of trackers was successfully returned |
Example response
Response
{
"1": {
"id": 1,
"created": "2025-07-29T12:53:20+00:00",
"code": "DISCOUNT10",
"notes": "Tracker code to provide a discount to early applicants",
"reduction": {
"reduction": "Percent",
"percent": 10
}
},
"2": {
"id": 2,
"created": "2025-08-27T09:18:38+00:00",
"code": "FACEBOOK",
"notes": null,
"reduction": null
}
}POST Create a tracker
Create a new tracker with the specified tracker code.
If a tracker with the same code exists, the request returns the 409 Conflict error and includes the URI of the existing tracker in the Location header.
This API request creates a new tracker but does not assign it to any applicants. To assign the tracker to one or more applicants, use PUT /api/v10/applicants/ID/trackers/ID.
Syntax
POST /api/v10/applicants/trackers
Host: apply.example.edu
Authorization: DREAM apikey="..."Parameters
| Name | Required\Optional | Description |
|---|---|---|
code | Required | The unique tracker code. Use the value that is easy to recognize. The allowed length is 2 to 16 characters. |
notes | Required | Additional information about the meaning of the tracker code. The allowed length is 2 to 200 characters. |
Example request
Request
curl
curl \
-X POST \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v10/applicants/trackers?code=2025¬es=fall%20campaign%20tracker"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | The media type of the resource |
Content-Length | 0 | The size of the response body in bytes |
Location | /api/applicants/trackers/NAME | The URI of the created tracker |
Response codes
| Response code | Description |
|---|---|
201 Created | A new tracker was created |
409 Conflict | A tracker with this code already exists |