GET objectives

Retrieves the list of objectives and their evaluations for the calling user.

Resource URL

https://www.drillster.com/api/2.1/objectives

Parameters

Field	Type	Description
`query` optional	String	An optional query string to limit the search results.
`drill` optional	String	An optional drill ID to limit the search results for objectives related to the given drill.
`resultStart` optional	Integer	The index number (zero-based) of the first objective to include in the result. Use this parameter, in combination with resultSize, to apply pagination of the result; it will limit the number of objectives included in the result. Defaults to `0`.
`resultSize` optional	Integer	The maximum number of objectives to include in the result. If not specified, the results for all (remaining) objectives are returned.
`includeCompleted` optional	Boolean	Whether to include the completed (met) objectives. By default these are omitted from the results.
`evaluationDate` optional	Date	An optional evaluation date to use in evaluating the objectives. If no date is given, the current date is used.

Response

A 2.1 Objectives object.

Example request

GET https://www.drillster.com/api/2.1/objectives

Response

{
  "total": 2,
  "objectives": [ {
    "id": "kjvxckKSQzG4XgwHKbXMp8",
    "icon": {
      "type": "image/jpeg",
      "url": "https://www.drillster.com/bin/drillable-icon/GaJX-LBX1yeVGVk1_yToIg.Y_Bw"
    },
    "type": "ONEOFF",
    "reviewDate": "2016-08-01T00:00:00Z",
    "minimumProficiency": 50,
    "fallingMinimumProficiency": 50,
    "evaluation": {
      "met": false,
      "proficiency": 13
    },
    "playables": [ {
      "id": "GaJX-LBXQyeVGVk1_yToIg",
      "type": "DRILL",
      "name": "Chapter one",
      "icon": {
        "type": "image/jpeg",
        "url": "https://www.drillster.com/bin/feature/ee4e64ed7554ab4e32423e88fff8feb06bf5ae52"
      }
    }, {
      "id": "3-RQwSJoSAOzMxpRUCXQuA",
      "type": "DRILL",
      "name": "Chapter two",
      "icon": {
        "type": "image/jpeg",
        "url": "https://www.drillster.com/bin/feature/e08ef011287e228655de1ebceed3511c3f3feb78"
      }
    } ]
  }, {
    "id": "QNKMuRxPmRv8KPsWy7WPWA",
    "icon": {
      "type": "image/png",
      "url": "https://www.drillster.com/bin/drillable-icon/gH_Jhy-CTvSmbXE_YA9l6w.u3Gr"
    },
    "type": "PERMANENT",
    "reviewDate": "2016-06-28T00:00:00Z",
    "minimumProficiency": 100,
    "fallingMinimumProficiency": 100,
    "evaluation": {
      "met": false,
      "proficiency": 91
    },
    "playables": [ {
      "id": "gH_Jhy-CTvSmbDE_XA9l6w",
      "type": "COURSE",
      "name": "Greek alphabet course",
      "icon": {
        "type": "image/png",
        "url": "https://www.drillster.com/bin/feature/7e58bac3a87addd8d89de71d0e5609ba359aa0b2"
      }
    } ]
  } ]
}

Error responses

The following error situations are possible:

ID	Response code	Description
`illegal_date`	400 (Bad request)	Given evaluation date is not valid.

Last updated on 2024-10-02