Skip to main content

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

Get today's goal plan​

Get today's goal plan. When a goal exists, goalId is the reading goal id to use with update/delete goal endpoints, while id is the activity day id.

Query Parameters
    type string required

    Possible values: [QURAN_TIME, QURAN_PAGES, QURAN_RANGE]

    The type of the goal.

    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

Header Parameters
    x-timezone string

    The current timezone of the user. Not providing the value might affect the accuracy of how we calculate days and streaks.

Responses

Request has been handled successfully.

Schema
    success boolean
    data object

    The Mushaf used to read on that day (will be included only when the type is QURAN)

    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

    id string

    The id of the activity day.

    date string

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

    The date of the activity day.

    progress float

    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

    Possible values: [QURAN, LESSON, QURAN_READING_PROGRAM]

    The activity category. Use QURAN for Quran reading progress; other values are for lessons and Quran reading programs.

    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

    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

    hasGoal boolean required

    Whether the user has a goal.

    goalId string

    The id of the reading goal. Present when hasGoal is true. Use this id with PUT /v1/goals/{id} and DELETE /v1/goals/{id}.

Loading...