Skip to main content

Generate timeline estimation‚Äč

Generate a timeline up to a week of the minimum daily amount required to meet the goal.

Query Parameters
    type string required

    Possible values: [QURAN_TIME, QURAN_PAGES, QURAN_RANGE, COURSE]

    The type of the goal.

    amount any required

    The amount of the goal. Depending on the goal type, the amount value and format will be different

    duration integer

    Possible values: >= 1

    The duration of the goal in days. If it's empty it means the goal is a daily goal and not duration-based.

    mushafId integer required

    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

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
    week object[]
  • Array [
  • date date-time required

    The date of the estimated day

    amount object required

    The amount of the day's goal.

    oneOf

    string

    The amount of the day's goal.

  • ]
Loading...