Zoom Public API Documentation
Get conversation scorecards
GET {{baseUrl}}/iq/conversations/:conversationId/scorecards?page_size=30&next_page_token=<string>
Get scorecards for a specific conversation. Scopes: Rate Limit Label: iq_coaching:read,iq_coaching:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"scorecards": [
{
"scorecard_id": "<string>",
"scorecard_name": "<string>",
"scorecard_description": "<string>",
"average_score": "<number>",
"rate_time": "<dateTime>",
"rater": {
"email": "<string>",
"display_name": "<string>",
"user_id": "<string>"
},
"scorecard_questions": [
{
"question_id": "<string>",
"question_title": "<string>",
"score": "<number>",
"question_description": "<string>",
"question_comment": "<string>",
"scale": {
"min_score_label": "<string>",
"max_score_label": "<string>"
}
},
{
"question_id": "<string>",
"question_title": "<string>",
"score": "<number>",
"question_description": "<string>",
"question_comment": "<string>",
"scale": {
"min_score_label": "<string>",
"max_score_label": "<string>"
}
}
]
},
{
"scorecard_id": "<string>",
"scorecard_name": "<string>",
"scorecard_description": "<string>",
"average_score": "<number>",
"rate_time": "<dateTime>",
"rater": {
"email": "<string>",
"display_name": "<string>",
"user_id": "<string>"
},
"scorecard_questions": [
{
"question_id": "<string>",
"question_title": "<string>",
"score": "<number>",
"question_description": "<string>",
"question_comment": "<string>",
"scale": {
"min_score_label": "<string>",
"max_score_label": "<string>"
}
},
{
"question_id": "<string>",
"question_title": "<string>",
"score": "<number>",
"question_description": "<string>",
"question_comment": "<string>",
"scale": {
"min_score_label": "<string>",
"max_score_label": "<string>"
}
}
]
}
],
"next_page_token": "<string>",
"page_size": 30
} |
Curl
curl -X GET 'https://api.zoom.us/v2/iq/conversations/:conversationId/scorecards?page_size=30&next_page_token=<string>?page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS