Skip to main content

Get streaks​

Get user streaks.

Query Parameters
    from string

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$

    The date after which any streaks would be returned (inclusive)

    to string

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$

    The date before which any streaks would be returned (inclusive)

    type string

    Possible values: [QURAN]

    The type of the streak

    sortOrder string

    Possible values: [asc, desc]

    Default value: desc

    The sorting order of orderBy field

    orderBy string

    Possible values: [startDate, days]

    Default value: startDate

    Which field to order the streaks by

    status string

    Possible values: [ACTIVE, BROKEN]

    The status of the streak.

    last integer

    Possible values: >= 1 and <= 20

    The number of items to be fetched. Should be used together with before

    first object

    Possible values: >= 1 and <= 20

    The number of items to be fetched.

    after object

    The cursor after which you want to get the next page of items. Should be used together with first

    before object

    The cursor before which the previous page of items will be fetched. Should be used together with last

Responses

Request has been handled successfully.

Schema
    success boolean
    data object[]
  • Array [
    • id string required

    The id of the streak.

    startDate string required

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$

    The date of the streak.

    endDate string required

    Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$

    The date of the streak.

    status string required

    Possible values: [ACTIVE, BROKEN]

    The status of the streak.

    days integer required

    The number of days the streak is/was active for.

  • ]
    • pagination object
    startCursor string
    endCursor string
    hasNextPage boolean
    hasPreviousPage boolean
Loading...