v1

latestSwagger 2.02026-08-06114161439.7 KB
scorecard

An array of scorecards

Retrieves scorecards accessible to the authenticated user based on organizational access permissions. Returns scorecard metadata including names, IDs, group access settings, creation details, and importance levels. Supports pagination and filtering.

get/scorecard/list

Query parameters

limitinteger

Maximum number of records to return per page. Integer, default 100, max 2000, min 1.

offsetinteger

Number of records to skip from the start of the result set. Integer, default 0, max 100000, min 0. Use with limit for pagination.

filterstring[]

Comma separated list of field column name with conditional (=, !=, <=, >=, >, <, like) followed by the value to compare against, Please make sure to add spaces after and before while using "like" operator example "call_flow_name like test_name". Can be any field included in the set of returned fields except group_access. All definitions as a whole must be URL encoded

Response

Scorecard metadata including names, identifiers, permissions, and creation details

group_idinteger

Organization unit (group) ID the call/record belongs to. Integer. Used to scope data; see /group/list for available group IDs.

scorecard_namestring

Human-readable scorecard name. String.

scorecard_idinteger

Unique identifier for a scorecard (conversation analytics scoring template). Integer.

group_accessinteger

shows the groups which has the access to scorecard. Type: integer (int32).

created_by_user_idinteger

who created the scorecard. Type: integer.

created_onstring date-time

when the scorecard was created. Type: string (date-time).

importanceinteger

shows the importance of scorecard. Type: integer (int32).