Get activity days
Get user activity days.
Query Parameters
Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$
The start date of the activity days
Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$
The last date of the activity days
Possible values: [asc
, desc
]
Default value: desc
Order by activity day's date
Possible values: [QURAN
, LESSON
]
The type of the activity day
Possible values: >= 1
and <= 20
The number of items to be fetched. Should be used together with before
Possible values: >= 1
and <= 20
The number of items to be fetched.
The cursor after which you want to get the next page of items. Should be used together with first
The cursor before which the previous page of items will be fetched. Should be used together with last
- 200
- 403
- 404
- 422
- 500
Request has been handled successfully.
Schema
- Array [
- ]
data object[]
The id of the activity day.
Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}$
The date of the activity day.
Possible values: <= 1
The progress of the reading goal of that activity day (if the user has a reading goal on that day).
Possible values: [QURAN
, LESSON
]
The type of the activity day
ranges object
The ranges read on that day (will be included only when the type is QURAN)
array
The ranges read on that day (will be included only when the type is QURAN)
pagesRead object
The number of pages read on that day (will be included only when the type is QURAN)
number
The number of pages read on that day (will be included only when the type is QURAN)
secondsRead object
The number of seconds spent reading on that day (will be included only when the type is QURAN)
integer
The number of seconds spent reading on that day (will be included only when the type is QURAN)
versesRead object
The number of Ayahs read on that day (will be included only when the type is QURAN)
integer
The number of Ayahs read on that day (will be included only when the type is QURAN)
manuallyAddedSeconds object
The number of seconds spent reading that was manually input by the user and not auto-tracked (will be included only when the type is QURAN)
integer
The number of seconds spent reading that was manually input by the user and not auto-tracked (will be included only when the type is QURAN)
dailyTargetPages object
The number of pages user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
number
The number of pages user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
dailyTargetSeconds object
The number of seconds user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
integer
The number of seconds user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
dailyTargetRanges object
The range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
array
The range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
remainingDailyTargetRanges object
The remaining range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
array
The remaining range of Ayahs user should read on that day to meet their goal's target if a goal was set (will be included only when the type is QURAN)
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 11
]
The id of the Mushaf being used.
1 = QCFV2
2 = QCFV1
3 = Indopak
4 = UthmaniHafs
5 = KFGQPCHAFS
6 = Indopak15Lines
7 = Indopak16Lines
11 = Tajweeed
pagination object
{
"success": true,
"data": [
{
"id": "clz897fr0000414qeccn6c92j",
"date": "2023-09-31",
"progress": 0.695,
"type": "QURAN",
"ranges": [
"1:1-1:2"
],
"pagesRead": 0,
"secondsRead": 0,
"versesRead": 0,
"manuallyAddedSeconds": 0,
"dailyTargetPages": 0,
"dailyTargetSeconds": 0,
"dailyTargetRanges": [
"1:1-1:2"
],
"remainingDailyTargetRanges": [
"1:1-1:2"
],
"mushafId": 4
}
],
"pagination": {
"startCursor": "clz897fpl000214qe6qyuec8g",
"endCursor": "clz897fpl000314qe1s9he2n0",
"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.
Schema
error object
{
"success": false,
"error": {
"code": "ForbiddenError",
"message": "Token expired"
}
}
Not Found. The resource being accessed does not exist.
Schema
error object
{
"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.
Schema
error object
{
"success": false,
"error": {
"code": "ValidationError",
"message": "`id` is required"
}
}
Server Error. Something went wrong, try again later.
Schema
error object
{
"success": false,
"error": {
"code": "ServerError",
"message": "Something went wrong"
}
}