Time periods are used in Boost to limit the view (or scope) of data presented in a dashboard. Typically they are academic years but custom time periods may be created for any date range.
https://teachboost.com/api/v1/timeperiods
- 15 requests are allowed every 60 seconds.
Options
This API call takes no options.
Sample Object
{
"type": "timeperiods",
"limit": 0,
"offset": 0,
"total": 2,
"time": "0.001s",
"items": {
"2016": {
"key": 2016,
"start": 1470009600,
"end": 1501459200
},
"2017": {
"key": 2017,
"start": 1501545600,
"end": 1532995200
}
},
"items_count": 2,
"status": "success",
"message": ""
}
Dictionary
-
key: String, unique key for the time period; use this for other API calls that take a time period flag -
start: DateTime, beginning of the time period -
end: DateTime, end of the time period