GET drillable/…/proficiency-chart

Retrieves the data required to plot a proficiency chart for a given drillable.

Resource URL

https://www.drillster.com/api/2.1.1/drillable/{drillable_id}/proficiency-chart

Parameters

Field	Type	Description
`drillable_id` required	String	The ID of the drill or course to retrieve the proficiency chart data for. Example value: `eSxMA4MISaCjJA43PgMEnQ`
`type` required	String constant	The proficiency chart type. This is either `NORMALIZED` or `STANDARD`.
`series` required	String constant	The data series to include in the graph. Valid options are: `SELF` `AVERAGE` For a `STANDARD` graph, only `SELF` is supported.
`mode` `optional`	String constant	An optional practice mode to plot. Valid options are: `RECEPTIVE` `PRODUCTIVE` `BIDIRECTIONAL` If the value is omitted, the default direction for the drill is used, and `BIDIRECTIONAL` for a course.

Response

A 2.1.1 ProficiencyChart object containing the data required to draw the chart for the drillable.

Example request

GET https://www.drillster.com/api/2.1.1/drillable/eSxMA4MISaCjJA43PgMEnQ/proficiency-chart?series=SELF&mode=BIDIRECTIONAL&type=NORMALIZED

Response

{
  "users": [ {
    "type": "USER",
    "id": "hs50JqouSRiKSC18ivn3mw"
  } ],
  "singular": false,
  "incomplete": false,
  "average": [[0, 0], [1, 4], [2, 4], [3, 9], [4, 9], [5, 9], [6, 13], [7, 13], [8, 13], [9, 13], [10, 17], [11, 13], [12, 17], [13, 22], [14, 22], [15, 12]],
  "extremes": [[0, 0, 0], [1, 0, 0], [2, 0, 0], [3, 0, 0], [4, 0, 0], [5, 0, 0], [6, 0, 0], [7, 0, 0], [8, 0, 0], [9, 0, 0], [10, 0, 0], [11, 0, 0], [12, 0, 0], [13, 0, 0], [14, 0, 0], [15, 0, 0]],
  "individuals": [[[0, 0], [1, 4], [2, 4], [3, 9], [4, 9], [5, 9], [6, 13], [7, 13], [8, 13], [9, 13], [10, 17], [11, 13], [12, 17], [13, 22], [14, 22], [15, 12]]]
}

Error responses

The following error situations are possible:

ID	Response code	Description
`invalid_mode`	400 (Bad request)	Mode must be `PRODUCTIVE`, `RECEPTIVE`, `BIDIRECTIONAL` or null.
`invalid_type`	400 (Bad request)	Type must be `NORMALIZED` or `STANDARD`.
`invalid_series`	400 (Bad request)	Series must be `SELF` or `AVERAGE`
`drillable_not_found`	404 (Not found)	Requested drillable could not be found.
`chart_error`	500 (Internal error)	Proficiency chart data could not be assembled.