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
data object[]
pagination object
{
"success": true,
"data": [
{
"id": "clxz57zxm000428nahfmq21cj",
"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": "clxz57zwl000228na02y67nxz",
"endCursor": "clxz57zwl000328na3ict452m",
"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"
}
}
GET /v1/activity-days/
Authorization
name: o_t_htype: apiKeyin: header
Request
Request
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'
curl -L -X GET 'https://auth.quran.foundation/v1/activity-days/' \
-H 'Accept: application/json' \
-H 'o_t_h: <API_KEY_VALUE>'