Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Klaus PublicExportApi API

The PublicExportApi API from Klaus — 18 operation(s) for publicexportapi.

Klaus PublicExportApi API is one of 2 APIs that Klaus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PublicExportApi. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 18 operations across 18 paths, and defines 67 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://yoursubdomain.zendesk.com/qa.

18 operations 18 paths 67 schemas 17 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://yoursubdomain.zendesk.com/qa
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Klaus PublicExportApi API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Enter the token with the "Bearer " prefix

Paths & Operations 18

Across 18 paths, the API surfaces 18 operations — 17 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

PublicExportApi 18
GET
/api/export/autoqa/ratings
AutoQARatings returns AutoQA rating rows for export
PublicExportApi_AutoQARatings 12 params → 200default
GET
/api/export/autoqa/reviews
AutoQAReviews returns AutoQA review rows for export
PublicExportApi_AutoQAReviews 9 params → 200default
POST
/api/export/conversations/search
ConversationSearch returns conversation data for the given request
PublicExportApi_ConversationSearch 1 param → 200default
GET
/api/export/csat
CSATByAccount returns CSAT for tickets
PublicExportApi_CSATByAccount 5 params → 200default
GET
/api/export/quizzes
Quizzes returns all quizzes
PublicExportApi_Quizzes → 200default
GET
/api/export/quizzes/leaderboard
QuizzesLeaderboard returns leaderboard of quizzes
PublicExportApi_QuizzesLeaderboard → 200default
GET
/api/export/quizzes/{id}/overview
QuizOverview returns specific quiz overview
PublicExportApi_QuizOverview 1 param → 200default
GET
/api/export/quizzes/{id}/responses
QuizResponses returns responses for specific quiz
PublicExportApi_QuizResponses 1 param → 200default
GET
/api/export/quizzes/{id}/responses/{response}
QuizResponse returns a single response for the specific quiz
PublicExportApi_QuizResponse 2 params → 200default
GET
/api/export/reviews
AccountReviews returns reviews and associated comments
PublicExportApi_AccountReviews 4 params → 200default
GET
/api/export/users
Users returns users belonging to specified account
PublicExportApi_Users → 200default
GET
/api/export/workspace/{workspace}/calibration-sessions
PublicExportApi_CalibrationSessions 5 params → 200default
GET
/api/export/workspace/{workspace}/csat
CSATByAccountAndWorkspace returns CSAT for tickets
PublicExportApi_CSATByAccountAndWorkspace 5 params → 200default
GET
/api/export/workspace/{workspace}/disputes
Disputes returns disputes
PublicExportApi_Disputes 5 params → 200default
GET
/api/export/workspace/{workspace}/reviews
Reviews returns reviews and associated comments
PublicExportApi_Reviews 5 params → 200default
GET
/api/export/workspace/{workspace}/scorecards
PublicExportApi_WorkspaceScorecards 1 param → 200default
GET
/api/export/workspace/{workspace}/users
WorkspaceUsers returns users belonging to specified account and workspace
PublicExportApi_WorkspaceUsers 1 param → 200default
GET
/api/export/workspaces
PublicExportApi_Workspaces → 200default

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are protoAutoQARatingRow (34 properties), protoTicketCSAT (20 properties), AdvancedScorecardScorecardRatingCategory (20 properties), protoAutoQAReviewRow (19 properties). Each schema is shown below with its type and property counts.

protoWorkspaceIdName
object
2 properties
AdvancedScorecardScorecardRootCause
object
2 properties
protoQuizFieldType
string
AdvancedScorecardMultiTierRootCause
object
2 properties
protoWorkspaceScorecardsResponse
object
2 properties
protoExportAPIReviewsResponse
object
2 properties
AdvancedScorecardRootCauseTierNode
object
7 properties
AdvancedScorecardRootCause
object
4 properties
protoExportAPICommentTag
object
2 properties
protoConversationSearchData
object
2 properties
protoAutoQAReviewsExportResponse
object
3 properties
protoQuizListResponse
object
1 property
protoExternalField
object
3 properties
AdvancedScorecardWorkspaceScorecard
object
6 properties
protoExportAPICalibrationConversation
object
4 properties
protoExportAPIDispute
object
16 properties
protoExportAPIComment
object
9 properties
protoAutoQAReviewRow
object
19 properties
protoExportAPICalibrationSession
object
7 properties
protoQuizFieldWithStatistics
object
7 properties
protoQuizListItem
object
11 properties
AdvancedScorecardRating
object
5 properties
protoExportAPIDisputeCategory
object
4 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
protoAccountWorkspacesResponse
object
1 property
AdvancedScorecardScorecardRatingCategory
object
20 properties
AdvancedScorecardScorecardRatingCategoryRating
object
2 properties
AdvancedScorecardScorecardRatingCategoryGroup
object
4 properties
protoScorecard
object
2 properties
protoConversationSearchResponse
object
1 property
protoPromptAnomalies
object
1 property
protoAutoQARatingsExportResponse
object
3 properties
protoPagination
object
3 properties
protoExportAPITagRequest
object
2 properties
protoStatus
string
protoExportAPIDisputeComment
object
7 properties
protoExportAPIReview
object
17 properties
protoQuizResponseOption
object
5 properties
protoQuizLeaderboardUser
object
7 properties
protoExportAPIUser
object
3 properties
protoUserData
object
3 properties
googlerpcStatus
object
3 properties
protoQuizWithStatistics
object
12 properties
AdvancedScorecardRootCauses
object
3 properties
protoExportAPICalibrationSessionsResponse
object
2 properties
AdvancedScorecardScorecardRootCauseTier
object
2 properties
AdvancedScorecardScorecardRatingCategoryCondition
object
3 properties
protoExportAPIUsersResponse
object
1 property
protoConversationSearchRequest
object
2 properties
protoQuizResponseItem
object
4 properties
protoReviewsRating
object
9 properties
protoQuizFieldProperty
object
2 properties
protoTicketCSAT
object
20 properties
protoTimeTrackingPeriod
object
2 properties
protoQuizLeaderboardResponse
object
1 property
protoQuizResponseField
object
8 properties
protoExportAPICalibrationComment
object
7 properties
protoQuizAndResponse
object
9 properties
protoExportAPICalibrationReview
object
14 properties
protoReviewsGroup
object
2 properties
protoAutoQARatingRow
object
34 properties
protoReviewsUser
object
4 properties
protoCSATResponse
object
2 properties
protoQuizFieldOptionWithStatistics
object
6 properties
protoExportAPIConversation
object
13 properties
protoQuizResponseItems
object
1 property
protoExportAPIDisputesResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

klaus-publicexportapi-api-openapi.yml Raw ↑

Other APIs Klaus publishes across the network.

Klaus PubImportApi API