curl --request POST \
--url https://api.alpha-1edtech.ai/goals/{studentId}/courses/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"courseId": "<string>",
"target": {
"metric": "xp",
"value": "<string>"
},
"pacing": {
"mode": "target_date",
"endDate": "<string>"
}
}
'{
"preview": {
"course": {
"id": "<string>",
"title": "<string>",
"subject": "<string>"
},
"goal": {
"target": {
"metric": "xp",
"value": "<string>"
},
"pacing": {
"mode": "target_date",
"endDate": "<string>"
}
},
"progress": {
"courseId": "<string>",
"courseTitle": "<string>",
"pctComplete": 123,
"pctCompleteApp": 123,
"pctCompleteLessons": 123,
"pctCompleteXP": 123,
"totalXP": 123,
"earnedXP": 123,
"remainingXP": 123,
"totalUnits": 123,
"completedUnits": 123,
"remainingUnits": 123,
"totalLessons": 123,
"completedLessons": 123,
"remainingLessons": 123
}
}
}Returns the product-shaped course goal preview without creating or updating a row.
curl --request POST \
--url https://api.alpha-1edtech.ai/goals/{studentId}/courses/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"courseId": "<string>",
"target": {
"metric": "xp",
"value": "<string>"
},
"pacing": {
"mode": "target_date",
"endDate": "<string>"
}
}
'{
"preview": {
"course": {
"id": "<string>",
"title": "<string>",
"subject": "<string>"
},
"goal": {
"target": {
"metric": "xp",
"value": "<string>"
},
"pacing": {
"mode": "target_date",
"endDate": "<string>"
}
},
"progress": {
"courseId": "<string>",
"courseTitle": "<string>",
"pctComplete": 123,
"pctCompleteApp": 123,
"pctCompleteLessons": 123,
"pctCompleteXP": 123,
"totalXP": 123,
"earnedXP": 123,
"remainingXP": 123,
"totalUnits": 123,
"completedUnits": 123,
"remainingUnits": 123,
"totalLessons": 123,
"completedLessons": 123,
"remainingLessons": 123
}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.timeback.com/llms.txt
Use this file to discover all available pages before exploring further.
The access token received from the authorization server in the OAuth 2.0 flow.
Student sourcedId
Course preview returned
Show child attributes