Get Scorecards

This guide describes how to use the Management APIs Get Scorecard by ID and Get Scorecards operations.

Authentication

Before using this API, you must generate your authentication token (AUTH_TOKEN) as described in Authenticate.

Use cases

  • Get scorecard by ID: Get a single scorecard by entering the ID.
  • Get all scorecards associated to your account.

Get scorecard by ID
The request to get a single scorecard by sending the scorecardId:

GET https://api.symbl.ai/v1/manage/callscore/scorecards/{scorecardId}

Sample Response

{
 "name": "Scorecard Name",
 "tags": ["tag-1", "tag-2", "tag-3"]
 "id": "4782752799653888",
 "criteriaList": ["684654556453497", "5476135688435435", "675462462156455"]
}

GET all scorecards associated to your account

GET https://api.symbl.ai/v1/manage/callscore/scorecards

Sample Response

[
  {
    "name": "This is my first scorecard",
    "tags": ["tag-a", "tag-b", "tag-c"]
    "id": "4782752799653888",
    "criteriaList": ["684654556453497", "5476135688435435", "675462462156455"]
      },
  {
    "name": "This is my second scorecard",
    "tags": ["tag-1", "tag-2", "tag-3"]
    "id": "4782790345894389",
    "criteriaList": ["Symbl.Communication_And_Engagement", "547634934835435", "675462462156455"]
   }
]