{ "swagger": "2.0", "info": { "title": "Public Export API", "description": "Export data from Zendesk QA.\n\n### Rate Limits:\n\n- API request limit: **1,500 requests per minute per IP**", "version": "1.0" }, "tags": [ { "name": "PublicExportApi" } ], "host": "yoursubdomain.zendesk.com", "basePath": "/qa", "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/api/export/autoqa/ratings": { "get": { "summary": "AutoQARatings returns AutoQA rating rows for export", "operationId": "PublicExportApi_AutoQARatings", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoAutoQARatingsExportResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "fromDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "workspaceId", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "connectionId", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "revieweeExternalId", "in": "query", "required": false, "type": "string" }, { "name": "latestOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "autoqaCategoryType", "in": "query", "required": false, "type": "string" }, { "name": "ratingCategoryId", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "rootCauseCode", "in": "query", "required": false, "type": "string" }, { "name": "cursor", "in": "query", "required": false, "type": "string" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/autoqa/reviews": { "get": { "summary": "AutoQAReviews returns AutoQA review rows for export", "operationId": "PublicExportApi_AutoQAReviews", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoAutoQAReviewsExportResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "fromDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "workspaceId", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "connectionId", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "revieweeExternalId", "in": "query", "required": false, "type": "string" }, { "name": "latestOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cursor", "in": "query", "required": false, "type": "string" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/conversations/search": { "post": { "summary": "ConversationSearch returns conversation data for the given request", "operationId": "PublicExportApi_ConversationSearch", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoConversationSearchResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/protoConversationSearchRequest" } } ], "tags": [ "PublicExportApi" ] } }, "/api/export/csat": { "get": { "summary": "CSATByAccount returns CSAT for tickets", "operationId": "PublicExportApi_CSATByAccount", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoCSATResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "workspace", "in": "query", "required": false, "type": "string", "format": "int64" }, { "name": "fromDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/quizzes": { "get": { "summary": "Quizzes returns all quizzes", "operationId": "PublicExportApi_Quizzes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoQuizListResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "PublicExportApi" ] } }, "/api/export/quizzes/leaderboard": { "get": { "summary": "QuizzesLeaderboard returns leaderboard of quizzes", "operationId": "PublicExportApi_QuizzesLeaderboard", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoQuizLeaderboardResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "PublicExportApi" ] } }, "/api/export/quizzes/{id}/overview": { "get": { "summary": "QuizOverview returns specific quiz overview", "operationId": "PublicExportApi_QuizOverview", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoQuizWithStatistics" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "int64" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/quizzes/{id}/responses": { "get": { "summary": "QuizResponses returns responses for specific quiz", "operationId": "PublicExportApi_QuizResponses", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoQuizResponseItems" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "int64" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/quizzes/{id}/responses/{response}": { "get": { "summary": "QuizResponse returns a single response for the specific quiz", "operationId": "PublicExportApi_QuizResponse", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoQuizAndResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "int64" }, { "name": "response", "in": "path", "required": true, "type": "string", "format": "int64" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/reviews": { "get": { "summary": "AccountReviews returns reviews and associated comments", "operationId": "PublicExportApi_AccountReviews", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoExportAPIReviewsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "fromDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/users": { "get": { "summary": "Users returns users belonging to specified account", "operationId": "PublicExportApi_Users", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoExportAPIUsersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "PublicExportApi" ] } }, "/api/export/workspace/{workspace}/calibration-sessions": { "get": { "operationId": "PublicExportApi_CalibrationSessions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoExportAPICalibrationSessionsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "type": "string", "format": "int64" }, { "name": "fromDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/workspace/{workspace}/csat": { "get": { "summary": "CSATByAccountAndWorkspace returns CSAT for tickets", "operationId": "PublicExportApi_CSATByAccountAndWorkspace", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoCSATResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "type": "string", "format": "int64" }, { "name": "fromDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/workspace/{workspace}/disputes": { "get": { "summary": "Disputes returns disputes", "operationId": "PublicExportApi_Disputes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoExportAPIDisputesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "type": "string", "format": "int64" }, { "name": "fromDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/workspace/{workspace}/reviews": { "get": { "summary": "Reviews returns reviews and associated comments", "operationId": "PublicExportApi_Reviews", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoExportAPIReviewsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "type": "string", "format": "int64" }, { "name": "fromDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "toDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/workspace/{workspace}/scorecards": { "get": { "operationId": "PublicExportApi_WorkspaceScorecards", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoWorkspaceScorecardsResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "type": "string", "format": "int64" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/workspace/{workspace}/users": { "get": { "summary": "WorkspaceUsers returns users belonging to specified account and workspace", "operationId": "PublicExportApi_WorkspaceUsers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoExportAPIUsersResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "parameters": [ { "name": "workspace", "in": "path", "required": true, "type": "string", "format": "int64" } ], "tags": [ "PublicExportApi" ] } }, "/api/export/workspaces": { "get": { "operationId": "PublicExportApi_Workspaces", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/protoAccountWorkspacesResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/googlerpcStatus" } } }, "tags": [ "PublicExportApi" ] } } }, "definitions": { "AdvancedScorecardMultiTierRootCause": { "type": "object", "properties": { "tiers": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardRootCauseTierNode" } }, "looseRootCauses": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRootCause" } } } }, "AdvancedScorecardRating": { "type": "object", "properties": { "rating": { "type": "integer", "format": "int32" }, "freeTextAllowed": { "type": "boolean" }, "rootCauses": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRootCause" } }, "tiers": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRootCauseTier" } }, "multiTierRootCause": { "$ref": "#/definitions/AdvancedScorecardMultiTierRootCause" } } }, "AdvancedScorecardRootCause": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "cause": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "AdvancedScorecardRootCauseTierNode": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "rootCauseCount": { "type": "string", "format": "int64" }, "canAddSubtiers": { "type": "boolean" }, "canAddRootCauses": { "type": "boolean" }, "subtiers": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardRootCauseTierNode" } }, "rootCauses": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardRootCause" } } } }, "AdvancedScorecardRootCauses": { "type": "object", "properties": { "multipleRequireReasons": { "type": "boolean" }, "freeTextAllowed": { "type": "boolean" }, "ratings": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardRating" } } } }, "AdvancedScorecardScorecardRatingCategory": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "ratingCategoryId": { "type": "string", "format": "int64" }, "scale": { "type": "string" }, "weight": { "type": "integer", "format": "int32" }, "critical": { "type": "boolean" }, "reviewCritical": { "type": "boolean" }, "groupCritical": { "type": "boolean" }, "position": { "type": "integer", "format": "int32" }, "skippable": { "type": "boolean" }, "conditions": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRatingCategoryCondition" } }, "rootCauses": { "$ref": "#/definitions/AdvancedScorecardRootCauses" }, "autoQaCategory": { "type": "string" }, "autoQaCustomCategoryTemplateId": { "type": "string" }, "status": { "type": "string" }, "autoQaApplicabilities": { "type": "array", "items": { "type": "string" } }, "autoQaPromptCategoryTemplateId": { "type": "string" }, "ratings": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRatingCategoryRating" } }, "promptAnomalies": { "$ref": "#/definitions/protoPromptAnomalies" } } }, "AdvancedScorecardScorecardRatingCategoryCondition": { "type": "object", "properties": { "condition": { "type": "string" }, "type": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } } }, "AdvancedScorecardScorecardRatingCategoryGroup": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "position": { "type": "integer", "format": "int32" }, "categories": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRatingCategory" } } } }, "AdvancedScorecardScorecardRatingCategoryRating": { "type": "object", "properties": { "rating": { "type": "string", "format": "int64" }, "description": { "type": "string" } } }, "AdvancedScorecardScorecardRootCause": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" } } }, "AdvancedScorecardScorecardRootCauseTier": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "AdvancedScorecardWorkspaceScorecard": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "categories": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRatingCategory" } }, "groups": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardScorecardRatingCategoryGroup" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "googlerpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protobufAny" } } } }, "protoAccountWorkspacesResponse": { "type": "object", "properties": { "workspaces": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoWorkspaceIdName" } } } }, "protoAutoQARatingRow": { "type": "object", "properties": { "autoqaRatingId": { "type": "string" }, "autoqaReviewId": { "type": "string" }, "accountId": { "type": "string", "format": "int64" }, "workspaceId": { "type": "string", "format": "int64" }, "workspaceName": { "type": "string" }, "connectionId": { "type": "string", "format": "int64" }, "externalTicketId": { "type": "string" }, "conversationCreatedAt": { "type": "string", "format": "date-time" }, "appConversationLink": { "type": "string" }, "externalConversationLink": { "type": "string" }, "revieweeExternalId": { "type": "string" }, "revieweeInternalId": { "type": "string" }, "revieweeName": { "type": "string" }, "revieweeEmail": { "type": "string" }, "ratingCategoryId": { "type": "string", "format": "int64" }, "ratingCategoryName": { "type": "string" }, "autoqaCategoryType": { "type": "string" }, "categoryDisplayName": { "type": "string" }, "scorecardId": { "type": "string", "format": "int64" }, "scorecardName": { "type": "string" }, "score": { "type": "number", "format": "double" }, "ratingScaleScore": { "type": "number", "format": "double" }, "ratingMax": { "type": "number", "format": "double" }, "ratingRangeMax": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "isCritical": { "type": "boolean" }, "reviewCritical": { "type": "boolean" }, "groupCritical": { "type": "boolean" }, "evaluated": { "type": "boolean" }, "rootCauseCodes": { "type": "array", "items": { "type": "string" } }, "rootCauses": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "paymentId": { "type": "string", "format": "int64" } } }, "protoAutoQARatingsExportResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoAutoQARatingRow" } }, "pagination": { "$ref": "#/definitions/protoPagination" }, "nextCursor": { "type": "string" } } }, "protoAutoQAReviewRow": { "type": "object", "properties": { "autoqaReviewId": { "type": "string" }, "accountId": { "type": "string", "format": "int64" }, "workspaceId": { "type": "string", "format": "int64" }, "workspaceName": { "type": "string" }, "connectionId": { "type": "string", "format": "int64" }, "externalTicketId": { "type": "string" }, "conversationCreatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "isBot": { "type": "boolean" }, "revieweeExternalId": { "type": "string" }, "revieweeInternalId": { "type": "string" }, "revieweeName": { "type": "string" }, "revieweeEmail": { "type": "string" }, "conversationChannel": { "type": "string" }, "language": { "type": "string" }, "appConversationLink": { "type": "string" }, "externalConversationLink": { "type": "string" }, "paymentId": { "type": "string", "format": "int64" } } }, "protoAutoQAReviewsExportResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoAutoQAReviewRow" } }, "pagination": { "$ref": "#/definitions/protoPagination" }, "nextCursor": { "type": "string" } } }, "protoCSATResponse": { "type": "object", "properties": { "tickets": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoTicketCSAT" } }, "pagination": { "$ref": "#/definitions/protoPagination" } } }, "protoConversationSearchData": { "type": "object", "properties": { "externalId": { "type": "string" }, "externalLink": { "type": "string" } } }, "protoConversationSearchRequest": { "type": "object", "properties": { "account": { "type": "string", "format": "int64" }, "endUserEmail": { "type": "string" } } }, "protoConversationSearchResponse": { "type": "object", "properties": { "conversations": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoConversationSearchData" } } } }, "protoExportAPICalibrationComment": { "type": "object", "properties": { "id": { "type": "string" }, "owner": { "$ref": "#/definitions/protoReviewsUser" }, "comment": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "createdISO": { "type": "string" }, "updatedISO": { "type": "string" } } }, "protoExportAPICalibrationConversation": { "type": "object", "properties": { "externalId": { "type": "string" }, "createdBy": { "type": "string", "format": "int64" }, "createdAt": { "type": "string" }, "reviews": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPICalibrationReview" } } } }, "protoExportAPICalibrationReview": { "type": "object", "properties": { "id": { "type": "string" }, "reviewer": { "$ref": "#/definitions/protoReviewsUser" }, "reviewee": { "$ref": "#/definitions/protoReviewsUser" }, "score": { "type": "number", "format": "double" }, "ratings": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoReviewsRating" } }, "comment": { "type": "string" }, "thread": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPICalibrationComment" } }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPICommentTag" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "received": { "type": "boolean" }, "scorecard": { "$ref": "#/definitions/protoScorecard" }, "createdISO": { "type": "string" }, "updatedISO": { "type": "string" } } }, "protoExportAPICalibrationSession": { "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "string", "format": "int64" }, "createdAt": { "type": "string" }, "title": { "type": "string" }, "dueAt": { "type": "string" }, "updatedAt": { "type": "string" }, "conversations": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPICalibrationConversation" } } } }, "protoExportAPICalibrationSessionsResponse": { "type": "object", "properties": { "calibrationSessions": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPICalibrationSession" } }, "pagination": { "$ref": "#/definitions/protoPagination" } } }, "protoExportAPIComment": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "owner": { "$ref": "#/definitions/protoReviewsUser" }, "comment": { "type": "string" }, "created": { "type": "string" }, "updated": { "type": "string" }, "thread": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIComment" } }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPICommentTag" } }, "createdISO": { "type": "string" }, "updatedISO": { "type": "string" } } }, "protoExportAPICommentTag": { "type": "object", "properties": { "tag": { "type": "string" }, "user": { "$ref": "#/definitions/protoReviewsUser" } } }, "protoExportAPIConversation": { "type": "object", "properties": { "externalId": { "type": "string" }, "url": { "type": "string" }, "externalUrl": { "type": "string" }, "lastUpdated": { "type": "string" }, "reviews": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIReview" } }, "comments": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIComment" } }, "workspaceId": { "type": "string", "format": "int64" }, "sourceType": { "type": "string" }, "createdAt": { "type": "string" }, "lastUpdatedISO": { "type": "string" }, "createdAtISO": { "type": "string" }, "externalFields": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExternalField" } }, "workspaceName": { "type": "string" } } }, "protoExportAPIDispute": { "type": "object", "properties": { "account": { "type": "string", "format": "int64" }, "workspace": { "type": "string", "format": "int64" }, "conversationId": { "type": "string" }, "connectionId": { "type": "string", "format": "int64" }, "reviewId": { "type": "string", "format": "int64" }, "disputeId": { "type": "string" }, "type": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/definitions/protoUserData" }, "assignee": { "$ref": "#/definitions/protoUserData" }, "status": { "type": "string" }, "resolutionTime": { "type": "string", "format": "int64" }, "categories": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIDisputeCategory" } }, "comment": { "$ref": "#/definitions/protoExportAPIDisputeComment" }, "resolvedAt": { "type": "string", "format": "date-time" }, "rejectedBy": { "$ref": "#/definitions/protoUserData" } } }, "protoExportAPIDisputeCategory": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "expectedRating": { "type": "integer", "format": "int32" }, "comment": { "$ref": "#/definitions/protoExportAPIDisputeComment" }, "rootCause": { "type": "array", "items": { "type": "string" } } } }, "protoExportAPIDisputeComment": { "type": "object", "properties": { "comment": { "type": "string" }, "commentTags": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPITagRequest" } }, "owner": { "$ref": "#/definitions/protoUserData" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "thread": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIDisputeComment" } }, "Id": { "type": "string", "format": "int64" } } }, "protoExportAPIDisputesResponse": { "type": "object", "properties": { "disputes": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIDispute" } }, "pagination": { "$ref": "#/definitions/protoPagination" } } }, "protoExportAPIReview": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "reviewer": { "$ref": "#/definitions/protoReviewsUser" }, "reviewee": { "$ref": "#/definitions/protoReviewsUser" }, "score": { "type": "number", "format": "double" }, "ratings": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoReviewsRating" } }, "comment": { "type": "string" }, "thread": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIComment" } }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPICommentTag" } }, "created": { "type": "string" }, "updated": { "type": "string" }, "received": { "type": "boolean" }, "reviewTime": { "type": "string", "format": "int64" }, "scorecard": { "$ref": "#/definitions/protoScorecard" }, "createdISO": { "type": "string" }, "updatedISO": { "type": "string" }, "pauseTime": { "type": "string", "format": "int64" }, "timeTrackingPeriods": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoTimeTrackingPeriod" } } } }, "protoExportAPIReviewsResponse": { "type": "object", "properties": { "conversations": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIConversation" } }, "pagination": { "$ref": "#/definitions/protoPagination" } } }, "protoExportAPITagRequest": { "type": "object", "properties": { "tag": { "type": "string" }, "userId": { "type": "string", "format": "int64" } } }, "protoExportAPIUser": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "email": { "type": "string" } } }, "protoExportAPIUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoExportAPIUser" } } } }, "protoExternalField": { "type": "object", "properties": { "externalId": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } } }, "protoPagination": { "type": "object", "properties": { "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "protoPromptAnomalies": { "type": "object", "properties": { "highNaRate": { "type": "boolean" } } }, "protoQuizAndResponse": { "type": "object", "properties": { "quizId": { "type": "string", "format": "int64" }, "responseId": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "int64" }, "userName": { "type": "string" }, "userAvatar": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizResponseField" } } } }, "protoQuizFieldOptionWithStatistics": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "label": { "type": "string" }, "correct": { "type": "boolean" }, "position": { "type": "string", "format": "int64" }, "selectedCount": { "type": "string", "format": "int64" }, "percentageSelected": { "type": "string", "format": "int64" } } }, "protoQuizFieldProperty": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "protoQuizFieldType": { "type": "string", "enum": [ "MULTIPLE_CHOICE" ], "default": "MULTIPLE_CHOICE" }, "protoQuizFieldWithStatistics": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "text": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "properties": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizFieldProperty" } }, "type": { "$ref": "#/definitions/protoQuizFieldType" }, "position": { "type": "string", "format": "int64" }, "options": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizFieldOptionWithStatistics" } } } }, "protoQuizLeaderboardResponse": { "type": "object", "properties": { "leaderboardUsers": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizLeaderboardUser" } } } }, "protoQuizLeaderboardUser": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "quizzesTaken": { "type": "string", "format": "int64" }, "ranking": { "type": "string", "format": "int64" }, "averageScorePercentage": { "type": "string", "format": "int64" }, "requesterCanManageAnyQuiz": { "type": "boolean" } } }, "protoQuizListItem": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "status": { "$ref": "#/definitions/protoStatus" }, "authorId": { "type": "string", "format": "int64" }, "authorName": { "type": "string" }, "authorAvatar": { "type": "string" }, "publishedDate": { "type": "string", "format": "date-time" }, "userResponseId": { "type": "string", "format": "int64" }, "numberOfParticipants": { "type": "string", "format": "int64" }, "averageScorePercentage": { "type": "string", "format": "int64" }, "workspaceIds": { "type": "array", "items": { "type": "string", "format": "int64" } } } }, "protoQuizListResponse": { "type": "object", "properties": { "quizzes": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizListItem" } } } }, "protoQuizResponseField": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "text": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "properties": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizFieldProperty" } }, "type": { "$ref": "#/definitions/protoQuizFieldType" }, "position": { "type": "string", "format": "int64" }, "options": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizResponseOption" } }, "answeredCorrectly": { "type": "boolean" } } }, "protoQuizResponseItem": { "type": "object", "properties": { "responseId": { "type": "string", "format": "int64" }, "userId": { "type": "string", "format": "int64" }, "userName": { "type": "string" }, "correctAnswerPercentage": { "type": "string", "format": "int64" } } }, "protoQuizResponseItems": { "type": "object", "properties": { "responses": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizResponseItem" } } } }, "protoQuizResponseOption": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "label": { "type": "string" }, "correct": { "type": "boolean" }, "position": { "type": "string", "format": "int64" }, "selected": { "type": "boolean" } } }, "protoQuizWithStatistics": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "$ref": "#/definitions/protoStatus" }, "createdBy": { "type": "string", "format": "int64" }, "updatedBy": { "type": "string", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "publishedDate": { "type": "string", "format": "date-time" }, "responseCount": { "type": "string", "format": "int64" }, "fields": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoQuizFieldWithStatistics" } }, "averageScorePercentage": { "type": "string", "format": "int64" } } }, "protoReviewsGroup": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "protoReviewsRating": { "type": "object", "properties": { "categoryId": { "type": "string", "format": "int64" }, "categoryName": { "type": "string" }, "score": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "critical": { "type": "boolean" }, "cause": { "type": "string" }, "causes": { "type": "array", "items": { "type": "string" } }, "groupName": { "type": "string" }, "groupId": { "type": "string", "format": "int64" } } }, "protoReviewsUser": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "avatar": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/protoReviewsGroup" } } } }, "protoScorecard": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" } } }, "protoStatus": { "type": "string", "enum": [ "DRAFT", "PUBLISHED", "DELETED", "ARCHIVED" ], "default": "DRAFT" }, "protoTicketCSAT": { "type": "object", "properties": { "externalTicketId": { "type": "string" }, "conversationUrl": { "type": "string" }, "ticketCreatedAt": { "type": "string", "format": "date-time" }, "csatCreatedAt": { "type": "string", "format": "date-time" }, "csatAnsweredAt": { "type": "string", "format": "date-time" }, "agentName": { "type": "string" }, "agentEmail": { "type": "string" }, "customerName": { "type": "string" }, "customerEmail": { "type": "string" }, "csatScore": { "type": "string", "format": "int64" }, "csatRawScore": { "type": "string" }, "csatComment": { "type": "string" }, "csatReason": { "type": "string" }, "conversationChannel": { "type": "string" }, "conversationSource": { "type": "string" }, "commentSize": { "type": "string" }, "commentWordCount": { "type": "string" }, "language": { "type": "string" }, "csatDrivers": { "type": "array", "items": { "type": "string" } }, "helpdeskTags": { "type": "array", "items": { "type": "string" } } } }, "protoTimeTrackingPeriod": { "type": "object", "properties": { "type": { "type": "string" }, "duration": { "type": "string", "format": "int64" } } }, "protoUserData": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "avatar": { "type": "string" } } }, "protoWorkspaceIdName": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" } } }, "protoWorkspaceScorecardsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "$ref": "#/definitions/AdvancedScorecardWorkspaceScorecard" } }, "total": { "type": "integer", "format": "int32" } } }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics." } }, "additionalProperties": {}, "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(\u0026foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := \u0026pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := \u0026pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": \u003cstring\u003e,\n \"lastName\": \u003cstring\u003e\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }" } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "description": "Enter the token with the \"Bearer \" prefix", "name": "Authorization", "in": "header" } }, "security": [ { "ApiKeyAuth": [] } ] }