Skip to content

View an evaluation form

Request:

GET /api/v2/evaluation_forms/<form-id>.json

Example of response (shortened to one section):

{
  "evaluation_form": {
    "form_id": "cd61b307-5e74-4c4b-b50a-f47100d51959",
    "tenant_id": "9d27913a-b7c3-11ed-9277-1207ffee24c3",
    "title": "Inbound Score Card",
    "description": null,
    "type": "auto",
    "active": true,
    "revision": 2246927,
    "pass_threshold": 80,
    "backfill": false,
    "modified_time": "2024-07-11T16:59:50.225592-07:00",
    "sections": [
      {
        "section_id": "a6c77eb8-191e-4eb6-a9ec-dddddc01c2c4",
        "title": "Greeting",
        "description": null,
        "allow_na": false,
        "weight": 1,
        "order": 1,
        "pass_threshold": 70,
        "revision": 2246927,
        "questions": [
          {
            "question_id": "8d64b248-63e0-487c-8a1f-c339c988e30e",
            "title": "Did the agent greet the caller appropriately?",
            "description": "The agent must thank the customer for calling, ask politely how he/she can help, etc.",
            "type": "ai_assist",
            "allow_na": true,
            "display_as": "radio_inline",
            "max_points": null,
            "weight": 1,
            "order": 1,
            "revision": null,
            "options": [
              {
                "option_id": "0e32ed7c-12d9-4305-ae04-eb496a3816ed",
                "title": "yes",
                "type": "points",
                "points": 10,
                "is_default": false,
                "auto_score_condition": null,
                "order": 1,
                "revision": null
              },
              {
                "option_id": "b12f842e-2569-4416-bf7c-41a029e1fd5a",
                "title": "no",
                "type": "points",
                "points": 0,
                "is_default": false,
                "auto_score_condition": null,
                "order": 2,
                "revision": null
              },
              {
                "option_id": "2d3b0e87-8521-42bb-ba05-d3a9e2e32d1b",
                "title": "n/a",
                "type": "na",
                "points": 0,
                "is_default": true,
                "auto_score_condition": null,
                "order": 3,
                "revision": null
              }
            ]
          }
        ]
      }
    ]
  }
}

Form attributes

Attribute Type Description
form_id UUID Unique ID of the form.
tenant_id UUID Tenant the form belongs to. Available only when multi-tenancy is enabled.
title string Name of the form, up to 64 characters.
description string or null Description, up to 4096 characters.
type string manual (evaluators score the calls) or auto (Auto QA scores the calls automatically).
active boolean Whether the form is active.
pass_threshold integer Passing score, 0 to 100.
backfill boolean Re-score the existing reports after the auto-score conditions of the form are edited.
revision integer Revision number of the form. It changes every time the form is edited. Evaluation reports record the revision they were scored with.
modified_time datetime Last modification time.
sections list Sections of the form. See Section attributes.

Section attributes

Attribute Type Description
section_id UUID Unique ID of the section.
title string Name of the section, up to 64 characters.
description string or null Description.
allow_na boolean Whether the whole section can be marked N/A.
weight integer Weight of the section in the total score, 1 to 1000.
order integer Position of the section in the form.
pass_threshold integer Passing score of the section, 0 to 100.
revision integer Revision of the section.
questions list Questions of the section. See Question attributes.

Question attributes

Attribute Type Description
question_id UUID Unique ID of the question.
title string Text of the question, up to 1024 characters.
description string or null Guidance for the evaluator, or for the AI assistant when type is ai_assist.
type string

Question type:

  • numeric - a numeric value up to max_points
  • options - multiple choice
  • auto_score - scored automatically by an MQL expression
  • ai_assist - scored by the AI assistant
allow_na boolean Whether the question can be marked N/A.
display_as string Widget in the evaluation form: radio (choice, multi-line), radio_inline (choice, single-line), input (input box), select (drop-down list), or stars (rating).
max_points integer or null Maximum points of a numeric question.
weight integer Weight of the question in the section score, 1 to 1000.
order integer Position of the question in the section.
revision integer or null Revision of the question.
options list Answer options. See Option attributes.

Option attributes

Attribute Type Description
option_id UUID Unique ID of the option.
title string Text of the option, up to 256 characters.
type string

Outcome when the option is selected:

  • points - award points
  • na - mark the question N/A
  • na_section - mark the section N/A
  • fail_section - fail the section
  • fail_form - fail the whole evaluation
points integer Points awarded, 0 to 1000.
is_default boolean Whether the option is selected by default.
auto_score_condition string or null MQL expression that selects this option, for auto_score questions. See the Moments Query Language reference.
order integer Position of the option.
revision integer or null Revision of the option.

Response contains HTTP status code as shown in the following table.

Response Description
200 OK The evaluation form is returned in the response body
403 Forbidden The request cannot be completed because API user has no permission to view evaluation forms
404 Not Found Evaluation form with such ID does not exist, or it is outside the access scope of the API user