API

List Course step completions

GET /v1/courses/{courseId}/participants/{courseParticipantId}/stepCompletions

List Course step completions

Path parameters

  • courseId string Required

    The id of the course

  • courseParticipantId string Required

    The id of the course participant

Query parameters

  • page integer | null

    The page number in a paginated set of results

  • limit integer | null

    The limit of results to be returned per page

  • completedAt[lt] integer

    Return elements with date before than this

  • completedAt[lte] integer

    Return elements with date before than or equal to this

  • completedAt[gt] integer

    Return elements with date after than this

  • completedAt[gte] integer

    Return elements with date after than or equal to this

  • completedAt[eq] integer

    Return elements with date equal to this

  • solution[in] array[string]

    Search course step completions with theses types of course content

    Values are Page or Quiz.

  • solution[eq] string

    Search course step completions with a specific content type

    Values are Page or Quiz.

Responses

  • 200 application/json

    Course step completions returned successfully

    Hide response attributes Show response attributes object
    • items array[object] Required

      The items found

      Hide items attributes Show items attributes object
      • id string Required

        The id of the course completion.

      • stepId string Required

        The id of the course step.

      • courseParticipantId string Required

        The id of the course participant.

      • contentType string Required

        The type of the course step.

        Values are Page or Quiz.

      • completedAt integer Required

        Timestamp in ms of completion date

    • total integer Required

      The total number of items found
  • 400

    Malformed payload

  • 404

    Course not found

GET /v1/courses/{courseId}/participants/{courseParticipantId}/stepCompletions 
curl \
 --request GET 'https://openapi.meltingspot.io/v1/courses/{courseId}/participants/{courseParticipantId}/stepCompletions'
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "stepId": "string",
      "courseParticipantId": "string",
      "contentType": "Page",
      "completedAt": 42
    }
  ],
  "total": 42
}