GET drill

GET Retrieves drill or course details.

Drill details are only accessible if the requested drill is (co-) authored by the calling user, if the drill is public, or if the calling user is a member of a group that contains the drill. If the calling user has the requested drill in the repertoire, the response will include individual progress details such as current proficiency and expected time to completion.

Resource URL

https://www.drillster.com/api/2/drill/{drill_id}

Parameters

Field Description
drill_id
required

The unique code identifying an individual drill or course.

Example value: eSxMA4MISaCjJA43PgMEnQ

If given a course ID instead of a drill ID, the course details will be returned. The response includes a type parameter indicating the type of the returned object.

Response

A 2.0 Drillable object, containing the details of the requested drill or course.

Example request (single drill)

In this example, a drill ID is given in the request, resulting in a response containing the details for that single drill.

GET https://www.drillster.com/api/2/drill/aD1yumG1SUyhyr3_SspN8w

Response

{
  "id" : "gDCIpKnSSA-JIFiQxPq31g",
  "name" : "European capitals",
  "subject" : "Geography",
  "type" : "DRILL",
  "size" : 47,
  "description" : "This drill will teach you the capitals of all European countries.",
  "practice" : {
    "proficiency" : {
      "receptive" : 66,
      "productive" : 63,
      "overall" : 64
    },
    "highestProficiency" : {
      "receptive" : 100,
      "productive" : 100,
      "overall" : 100
    },
    "timeSpent" : 42,
    "expectedDuration" : 1661
  },
  "icon" : {
    "type" : "image/jpeg",
    "url" : "https://www.drillster.com/bin/drillable-icon/gDCIpKnSSA-JIFiQxPq31g"
  },
  "cover" : {
    "type" : "image/png",
    "url" : "https://www.drillster.com/bin/cover/8e9851b360f9dd13aac3d4d3576958982873da6f"
  },
  "license" : {
    "type" : "OPEN",
    "text" : "Published under a Creative Commons license",
    "icon" : {
      "url" : "http://i.creativecommons.org/l/by-sa/3.0/88x31.png"
    },
    "link" : "http://www.creativecommons.org"
  },
  "compatibility" : {
    "compatible" : false,
    "unsupportedFeatures" : [ "IMAGE_MEDIA", "AUDIO_MEDIA" ]
  },
  "columns" : {
    "knownColumn" : {
      "name" : "Country"
    },
    "unknownColumns" : [ {
      "name" : "Capital"
    } ]
  },
  "restrictions" : {
    "direction" : "PRODUCTIVE",
    "unknownStyle" : "OPEN_ENDED"
  },
  "affordances" : [ "REMOVING", "PLAYING" ]
}

Example request (course)

In this example, a course ID is given in the request, resulting in a response containing the details for the course, plus the details for each drill contained in that course.

GET https://www.drillster.com/api/2/drill/vGjy2yRUR-aMrUKAt_eAuw

Response

{
  "id" : "vGjy2yRUR-aMrUKAt_eAuw",
  "name" : "Spelling Bee 2012 practice words",
  "subject" : "English",
  "type" : "COURSE",
  "size" : 150,
  "description" : "This course contains three drills with a total of 150 practice words for the 2012 Spelling Bee.",
  "practice" : {
    "proficiency" : {
      "overall" : 31
    },
    "expectedDuration" : 27495,
    "icon" : {
      "url" : "https://www.drillster.com/bin/drillable-icon/vGjy2yRUR-aMrUKAt_eAuw"
    }
  },
  "drills" : [ {
    "id" : "aD1yumG1SUyhyr3_SspN8w",
    "name" : "Spelling Bee 2012 practice words (1/3)",
    "subject" : "English",
    "type" : "DRILL",
    "size" : 50,
    "description" : "A list of 150 practice words for the 2012 spelling bee. This is part 1 out of 3.",
    "practice" : {
      "proficiency" : {
        "overall" : 51
      },
      "highestProficiency" : {
        "overall" : 100
      },
      "expectedDuration" : 2369,
      "icon" : {
        "url" : "https://www.drillster.com/bin/drillable-icon/aD1yumG1SUyhyr3_SspN8w"
      }
    }
  }, {
    "id" : "Eny-DpBlR4GlmzMVc3aV7Q",
    "name" : "Spelling Bee 2012 practice words (2/3)",
    "subject" : "English",
    "type" : "DRILL",
    "size" : 50,
    "description" : "A list of 150 practice words for the 2012 spelling bee. This is part 2 out of 3.",
    "practice" : {
      "proficiency" : {
        "overall" : 47
      },
      "highestProficiency" : {
        "overall" : 100
      },
      "expectedDuration" : 1206,
      "icon" : {
        "url" : "https://www.drillster.com/bin/drillable-icon/Eny-DpBlR4GlmzMVc3aV7Q"
      }
    }
  }, {
    "id" : "2xT5S_O_SvO31YLC1ra3hw",
    "name" : "Spelling Bee 2012 practice words (3/3)",
    "subject" : "English",
    "type" : "DRILL",
    "size" : 50,
    "description" : "A list of 150 practice words for the 2012 spelling bee. This is part 3 out of 3.",
    "practice" : {
      "proficiency" : {
        "overall" : 28
      },
      "highestProficiency" : {
        "overall" : 55
      },
      "expectedDuration" : 1342,
      "icon" : {
        "url" : "https://www.drillster.com/bin/drillable-icon/2xT5S_O_SvO31YLC1ra3hw"
      }
    }
  } ]
}

The type is used to differentiate drills from courses, and will be set to DRILL for drills, and COURSE for courses.

Error responses

The following error situations are possible:

ID Description
unknown_drill The specified drill or course was not found
no_drill_access You don't have permission to access this drill or course