csat

Get Csat Prompt State

Changed on

Check if user should see CSAT prompt for given type. Updates visit counters and returns whether to show prompt.

post/csat/prompt

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/csat/prompt
  • Auth: OAuth 2 (password, token URL api/login)

Request body

csat_type'transcription' | 'transcription_figure' | 'transcription_correction' | 'correction' | 'assignment' | 'batch_upload' | 'home_redesign_v2' | 'chat_redesign_v1' | 'mobile_toolbar_redesign_v1' | 'chat_message_satisfaction' | 'copy_correction_upload' | 'copy_correction_grading' | 'student_copy_viewing' | 'student_dm_results_v25' | 'student_answer_submission_v25' | 'teacher_dm_results_v25' | 'figure_generation' | 'student_practice_picker_v1' | 'student_progression_v1' | 'teacher_physics_library_v1' | 'student_copy_review_v1' | 'teacher_tutorial_video_v1' required
subject_keystring nullable

Response

Successful Response

should_promptboolean required
prompt_indexinteger required

Changes

  • aa42640c0a6bRevision changes
    • info

      added the new optional request property

    • info

      added the new teacher_tutorial_video_v1 enum value to the request property

  • 1d6009058248Revision changes
    • info

      added the new student_copy_review_v1 enum value to the request property