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

• 200
• 403
• 404
• 422
• 500

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

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

{
  "success": true,
  "data": [
    {
      "id": "cm3k2ds4d000f0jpz50jaf17w",
      "startDate": "2023-09-01",
      "endDate": "2023-09-31",
      "status": "ACTIVE",
      "days": 5
    }
  ],
  "pagination": {
    "startCursor": "cm3k2dqmv00020jpz5yp725xy",
    "endCursor": "cm3k2dqmv00030jpz8v8w4hg6",
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ForbiddenError",
    "message": "Token expired"
  }
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "NotFoundError",
    "message": "The resource you're looking for does not exist"
  }
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ValidationError",
    "message": "`id` is required"
  }
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

---

Schema

success boolean
error object
code string
message string

{
  "success": false,
  "error": {
    "code": "ServerError",
    "message": "Something went wrong"
  }
}

Loading...