Get today's goal plan

Get today's goal plan.

Query Parameters

type string required

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

The type of the goal.

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.

application/json

Schema

Example (from schema)

Schema

success boolean

data object

oneOf

object

{
  "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
  }
}

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 today's goal plan​

Get today's goal plan