Get activity days

Get user activity days.

Query Parameters

from string

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

The start date of the activity days

to string

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

The last date of the activity days

dateOrderBy string

Possible values: [asc, desc]

Default value: desc

Order by activity day's date

type string

Possible values: [QURAN, LESSON]

The type of the activity day

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.

application/json

Schema

Example (from schema)

Schema

success boolean

data object[]

Array [

id string required

The id of the activity day.

date string required

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

The date of the activity day.

progress float required

Possible values: <= 1

The progress of the reading goal of that activity day (if the user has a reading goal on that day).

type string required

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)

oneOf

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)

oneOf

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)

oneOf

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)

oneOf

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)

oneOf

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)

oneOf

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)

oneOf

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)

oneOf

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)

oneOf

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)

mushafId integer required

Possible values: [1, 2, 3, 4, 5, 6, 7, 11, 19]

The id of the Mushaf being used.

1 = QCFV2

2 = QCFV1

3 = Indopak

4 = UthmaniHafs

5 = KFGQPCHAFS

6 = Indopak15Lines

7 = Indopak16Lines

11 = Tajweeed

19 = QCFTajweedV4

]

pagination object

startCursor string

endCursor string

hasNextPage boolean

hasPreviousPage boolean

{
  "success": true,
  "data": [
    {
      "id": "cm4v8am2700047iq99bjc9wh1",
      "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": "cm4v8am0o00027iq97l0sbkl4",
    "endCursor": "cm4v8am0p00037iq9dwbo61rg",
    "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"
  }
}

Get activity days​

Get activity days