Skip to main content

List interactive stories

GET 
/stories

This endpoint retrieves a list of available stories.
It supports advanced filtering and sorting options for the associated quiz data.
Filtering Options:

  • filter=quiz=true: Lists all Stories that have an active quiz feature.
  • filter=quiz.isMandatory=true: Lists all Stories where the quiz is mandatory for the user.
  • filter=quiz.isOpenToTake=true: Lists all Stories where the quiz is currently open for the user to take an attempt.
  • filter=quiz.isSuccess=true: Lists all Stories with successfully finished attempt and showing result is enabled.
  • filter=quiz.isFailure=true: Lists all Stories with failed attempt and showing result is enabled.

Sorting Options:

  • sort=quiz.dueUntilUtc:desc: Sorts the list by the quiz expiry date in descending order.
  • sort=quiz.report.rate:desc: Sorts the list by the latest attempt rate in descending order.
  • sort=quiz.latestAttemptUtc:desc: Sorts the list by the latest attempt time in descending order.

Note: Omitting :desc in the sorting parameter reverses the sorting order to ascending. For example, sort=quiz.dueUntilUtc will sort by the expiry date in ascending order.
By leveraging these filters and sorting parameters, users can efficiently query Stories tailored to specific conditions and priorities.

Request​

Responses​

Successful response.

Response Headers
    X-Total-Count

    Total count of items