Sign in
Lessons

Get All

Get all the lessons.

get/public/api/lessons?filter={filter}

Query parameters

filterstring

A valid JSON filter object

Headers

Acceptstring

e.g. application/json

Request body

Example request

{
  "Authorization": {
    "Authorization": "Bearer JWT"
  }
}

Response

OK

lesson_idstring required
titlestring required
typestring required
campaign_idstring required
plan_idstring required
course_idstring required
user_idstring required
statusstring required
validatedboolean required
tenantstring required
created_datestring required
updated_datestring required
pointsnumber

Example response

[
  {
    "lesson_id": "5c7004c1b31ec3003a56af4e",
    "title": "Feedback",
    "type": "lesson",
    "campaign_id": "5c582b8f4a35650044aea049",
    "plan_id": "5bf2d58ae553190041467eef",
    "course_id": "5bf4448528b7420041ba9b62",
    "user_id": "5beee3717fc4d50043801a97",
    "status": "finished",
    "score": {
      "total": 0,
      "value": 0
    },
    "validated": true,
    "tenant": "testproductv6_boost",
    "created_date": "2019-02-22T14:18:41.667Z",
    "updated_date": "2019-02-22T14:18:41.667Z",
    "answers": [
      {
        "question_id": "e886902d-ddef-43c1-8894-c9f5f101fa56",
        "question_type": "feedback",
        "question": "Feedback",
        "page_number": 1,
        "question_number": 1,
        "answer": 3
      }
    ]
  },
  {
    "lesson_id": "5c7004b8b31ec3003a56af0c",
    "title": "Categories",
    "type": "lesson",
    "campaign_id": "5c582b5b4a35650044aea033",
    "plan_id": "5bf2d58ae553190041467eef",
    "course_id": "5bf4448528b7420041ba9b62",
    "user_id": "5beee3717fc4d50043801a97",
    "status": "finished",
    "points": 10,
    "score": {
      "total": 1,
      "value": 100,
      "isPercentage": true,
      "completed": 1
    },
    "validated": true,
    "tenant": "testproductv6_boost",
    "created_date": "2019-02-22T14:18:32.878Z",
    "updated_date": "2019-02-22T14:18:32.878Z",
    "answers": [
      {
        "question_id": "fd91d037-769d-46d8-ac56-059a85db745e",
        "question_type": "categorizewords",
        "question": "Categorize words",
        "page_number": 1,
        "question_number": 1,
        "answer": [
          [
            "1",
            "2",
            "3"
          ],
          [
            "A",
            "B",
            "C"
          ]
        ]
      }
    ]
  }
]

Changes

No recorded changes to this endpoint across all 4 revisions of this API.