GET proficiency-graph

GET Returns a ready-made proficiency graph in PNG-format for a specific drill.

Strictly speaking, the production of PNG images for proficiency graphs is not part of the API, but it can be a useful addition to any API client application. Depending on whether the drill is public and whether the user has placed the drill in the repertoire, the individual and aggregate components are displayed.

Resource URL

https://www.drillster.com/proficiency-graph/{drill_id}.png

Parameters

The following parameters may be appended as a query string:

Field Description
mode
optional

Whether to return the receptive, productive or combined proficiency values. If omitted, the bidirectional values are used.

Possible values:

  • RECEPTIVE
  • PRODUCTIVE
  • BIDIRECTIONAL

width
optional

The width of the returned image, in pixels. If omitted, 600 pixels is used.

height
optional

The height of the returned image, in pixels. If omitted, 250 pixels is used.

opacity
optional

The opacity of the graph background. If omitted, 1.0 is used, i.e. fully opaque.

colorAverage
optional

The color code for the 'average' line in the graph. Colors should be encoded in hexadecimal rrggbb-format. The #-sign is optional, and three digit color codes are understood.

colorDeviation
optional

The color code for the 'deviation' area in the graph.

colorIndividual
optional

The color code for the 'individual' line in the graph.

includeAxes
optional

Whether to include axes in the returned image. If omitted, axes are not drawn.

Possible values:

  • true
  • false

Response

A freshly made PNG image with a proficiency graph.

Example proficiency graph

Error responses

The following error situations are possible:

ID Description
invalid_input One or more given parameter values were not valid
not_found The requested drill was not found
internal_error The production of the graph image failed