Send lesson plan feedback
Record a teacher’s rating and comments on a lesson plan or on one of its steps.
POST
Send lesson plan feedback
Use
step_name to point feedback at one part of the lesson plan: metadata, alignment, content_generation, or additional_blocks. Leave it out for feedback on the whole lesson plan.
Rules
commentandfeedback_typeare required.feedback_typemust begeneral,content,quality, orsuggestion.ratingis optional, and must be between 1 and 5 if you send it.- You can send feedback at any point in the flow, and as many times as you like.
201. The id in the response is the new feedback’s ID, not the lesson plan ID.
step_name and component_name are stored as you send them. The API doesn’t check them against the step names above, so use those exact values if you want to group feedback by step later.Authorizations
Access token from Get an access token.
Path Parameters
The lesson plan id returned by Start a lesson plan.
Example:
"7d2f1b90-4c6a-4f3e-b1d7-9a5e2c8f0b34"
Body
application/json
The feedback text.
Available options:
general, content, quality, suggestion Required range:
1 <= x <= 5The step the feedback is about: metadata, alignment, content_generation, or additional_blocks. Leave it out for feedback on the whole lesson plan. Any string is accepted.
A specific part of the step, if relevant.
Any structured data you want to store with the feedback.
Response
Feedback saved. id is the feedback ID.