How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Genesys Quality API

Evaluations, calibrations

Genesys Quality API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Quality. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 72 operations across 48 paths, and defines 190 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

72 operations 48 paths 190 schemas 8 DELETE36 GET1 PATCH19 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys Quality API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 72

Across 48 paths, the API surfaces 72 operations — 8 DELETE, 36 GET, 1 PATCH, 19 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Quality 72

Evaluations, calibrations

POST
/api/v2/analytics/evaluations/aggregates/query
Query for evaluation aggregates
postAnalyticsEvaluationsAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/evaluations/aggregates/jobs
Query for evaluation aggregates asynchronously
postAnalyticsEvaluationsAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/evaluations/aggregates/jobs/{jobId}
Get status for async query for evaluation aggregates
getAnalyticsEvaluationsAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/evaluations/aggregates/jobs/{jobId}
Delete/cancel an async request for evaluation aggregates
deleteAnalyticsEvaluationsAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsEvaluationsAggregatesJobResults 2 params → 200400401403404408409413
POST
/api/v2/analytics/surveys/aggregates/query
Query for survey aggregates
postAnalyticsSurveysAggregatesQuery 1 param → 200400401403404408409413
POST
/api/v2/analytics/surveys/aggregates/jobs
Query for survey aggregates asynchronously
postAnalyticsSurveysAggregatesJobs 1 param → 202400401403404408409413
GET
/api/v2/analytics/surveys/aggregates/jobs/{jobId}
Get status for async query for survey aggregates
getAnalyticsSurveysAggregatesJob 1 param → 200202400401403404408409
DELETE
/api/v2/analytics/surveys/aggregates/jobs/{jobId}
Delete/cancel an async request for survey aggregates
deleteAnalyticsSurveysAggregatesJob 1 param → 204400401403404408409413
GET
/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results
Fetch a page of results for an async aggregates query
getAnalyticsSurveysAggregatesJobResults 2 params → 200400401403404408409413
GET
/api/v2/quality/surveys/scorable
Get a survey as an end-customer, for the purposes of scoring it.
getQualitySurveysScorable 1 param → 200400401403404408409413
PUT
/api/v2/quality/surveys/scorable
Update a survey as an end-customer, for the purposes of scoring it.
putQualitySurveysScorable 2 params → 200400401403404408409413
GET
/api/v2/quality/agents/activity
Gets a list of Agent Activities
getQualityAgentsActivity 15 params → 200400401403404408409413
GET
/api/v2/quality/programs/{programId}/agentscoringrules/{ruleId}
Get an Agent Scoring Rule
getQualityProgramAgentscoringrule 2 params → 200400401403404408409413
PUT
/api/v2/quality/programs/{programId}/agentscoringrules/{ruleId}
Update an Agent Scoring Rule
putQualityProgramAgentscoringrule 3 params → 200400401403404408409413
DELETE
/api/v2/quality/programs/{programId}/agentscoringrules/{ruleId}
Delete an Agent Scoring Rule
deleteQualityProgramAgentscoringrule 2 params → 204400401403404408409413
GET
/api/v2/quality/programs/{programId}/agentscoringrules
Get Agent Scoring Rules for a program
getQualityProgramAgentscoringrules 1 param → 200400401403404408409413
POST
/api/v2/quality/programs/{programId}/agentscoringrules
Create an Agent Scoring Rule
postQualityProgramAgentscoringrules 2 params → 200400401403404408409413
GET
/api/v2/quality/calibrations/{calibrationId}
Get a calibration by id. Requires either calibrator id or conversation id
getQualityCalibration 3 params → 200400401403404408409413
PUT
/api/v2/quality/calibrations/{calibrationId}
Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
putQualityCalibration 2 params → 200400401403404408409413
DELETE
/api/v2/quality/calibrations/{calibrationId}
Delete a calibration by id.
deleteQualityCalibration 2 params → 200400401403404408409413
GET
/api/v2/quality/calibrations
Get the list of calibrations
getQualityCalibrations 10 params → 200400401403404408409413
POST
/api/v2/quality/calibrations
Create a calibration
postQualityCalibrations 2 params → 200400401403404408409413
GET
/api/v2/quality/conversations/audits/query/{transactionId}/results
Get results of audit query
getQualityConversationsAuditsQueryTransactionIdResults 4 params → 200400401403404408409413
POST
/api/v2/quality/conversations/audits/query
Create audit query execution
postQualityConversationsAuditsQuery 1 param → 200202400401403404408409
GET
/api/v2/quality/conversations/audits/query/{transactionId}
Get status of audit query execution
getQualityConversationsAuditsQueryTransactionId 1 param → 200202400401403404408409
GET
/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
Get an evaluation
getQualityConversationEvaluation 3 params → 200400401403404408409413
PUT
/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
Update an evaluation
putQualityConversationEvaluation 4 params → 200400401403404408409413
DELETE
/api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
Delete an evaluation
deleteQualityConversationEvaluation 3 params → 200400401403404408409413
POST
/api/v2/quality/conversations/{conversationId}/evaluations
Create an evaluation
postQualityConversationEvaluations 4 params → 200400401403404408409413
GET
/api/v2/quality/conversations/{conversationId}/surveys
Get the surveys for a conversation
getQualityConversationSurveys 1 param → 200400401403404408409413
POST
/api/v2/quality/evaluations/aggregates/query/me
Query for evaluation aggregates for the current user
postQualityEvaluationsAggregatesQueryMe 1 param → 200400401403404408409413
PUT
/api/v2/quality/forms/evaluations/{formId}/aiscoring/settings
Update the AI Scoring settings of an evaluation form.
putQualityFormsEvaluationAiscoringSettings 2 params → 200400401403404408409413
GET
/api/v2/quality/forms/evaluations/{formId}
Get an evaluation form
getQualityFormsEvaluation 1 param → 200400401403404408409413
PUT
/api/v2/quality/forms/evaluations/{formId}
Update an evaluation form.
putQualityFormsEvaluation 2 params → 200400401403404408409413
DELETE
/api/v2/quality/forms/evaluations/{formId}
Delete an evaluation form.
deleteQualityFormsEvaluation 1 param → 204400401403404408409413
GET
/api/v2/quality/forms/evaluations/{formId}/versions
Gets all the revisions for a specific evaluation.
getQualityFormsEvaluationVersions 4 params → 200400401403404408409413
GET
/api/v2/quality/forms/evaluations/bulk
Retrieve a list of evaluation forms by their ids
getQualityFormsEvaluationsBulk 2 params → 200400401403404408409413
GET
/api/v2/quality/forms/evaluations/bulk/contexts
Retrieve a list of the latest published evaluation form versions by context ids
getQualityFormsEvaluationsBulkContexts 1 param → 200400401403404408409413
GET
/api/v2/quality/forms/evaluations
Get the list of evaluation forms
getQualityFormsEvaluations 8 params → 200400401403404408409413
POST
/api/v2/quality/forms/evaluations
Create an evaluation form.
postQualityFormsEvaluations 1 param → 200400401403404408409413
GET
/api/v2/quality/evaluations/query
Queries Evaluations and returns a paged list
getQualityEvaluationsQuery 20 params → 200400401403404408409413
POST
/api/v2/quality/evaluations/scoring
Score evaluation
postQualityEvaluationsScoring 1 param → 200400401403404408409413
POST
/api/v2/quality/evaluations/search
Search evaluations based along specified criteria
postQualityEvaluationsSearch 1 param → 200400401403404408409413
GET
/api/v2/quality/evaluators/activity
Get an evaluator activity. To ensure optimal performance and prevent timeouts when processing large datasets, startTime and endTime fields are highly recommended for all requests.
getQualityEvaluatorsActivity 12 params → 200400401403404408409413
GET
/api/v2/quality/publishedforms/evaluations/{formId}
Get the most recent published version of an evaluation form.
getQualityPublishedformsEvaluation 1 param → 200400401403404408409413
GET
/api/v2/quality/publishedforms/evaluations
Get the published evaluation forms.
getQualityPublishedformsEvaluations 4 params → 200400401403404408409413
POST
/api/v2/quality/publishedforms/evaluations
Publish an evaluation form.
postQualityPublishedformsEvaluations 1 param → 200400401403404408409413
GET
/api/v2/quality/publishedforms/surveys/{formId}
Get the most recent published version of a survey form.
getQualityPublishedformsSurvey 1 param → 200400401403404408409413
GET
/api/v2/quality/publishedforms/surveys
Get the published survey forms.
getQualityPublishedformsSurveys 4 params → 200400401403404408409413
POST
/api/v2/quality/publishedforms/surveys
Publish a survey form.
postQualityPublishedformsSurveys 1 param → 200400401403404408409413
GET
/api/v2/quality/forms/surveys/{formId}
Get a survey form
getQualityFormsSurvey 1 param → 200400401403404408409413
PUT
/api/v2/quality/forms/surveys/{formId}
Update a survey form.
putQualityFormsSurvey 2 params → 200400401403404408409413
DELETE
/api/v2/quality/forms/surveys/{formId}
Delete a survey form.
deleteQualityFormsSurvey 1 param → 204400401403404408409413
PATCH
/api/v2/quality/forms/surveys/{formId}
Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.
patchQualityFormsSurvey 2 params → 200400401403404408409413
GET
/api/v2/quality/forms/surveys/{formId}/versions
Gets all the revisions for a specific survey.
getQualityFormsSurveyVersions 3 params → 200400401403404408409413
GET
/api/v2/quality/forms/surveys/bulk
Retrieve a list of survey forms by their ids
getQualityFormsSurveysBulk 1 param → 200400401403404408409413
GET
/api/v2/quality/forms/surveys/bulk/contexts
Retrieve a list of the latest form versions by context ids
getQualityFormsSurveysBulkContexts 2 params → 200400401403404408409413
GET
/api/v2/quality/forms/surveys
Get the list of survey forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding survey form.
getQualityFormsSurveys 8 params → 200400401403404408409413
POST
/api/v2/quality/forms/surveys
Create a survey form.
postQualityFormsSurveys 1 param → 200400401403404408409413
GET
/api/v2/quality/surveys/{surveyId}
Get a survey for a conversation
getQualitySurvey 1 param → 200400401403404408409413
POST
/api/v2/quality/surveys/scoring
Score survey
postQualitySurveysScoring 1 param → 200400401403404408409413
POST
/api/v2/quality/surveys
Create a survey for a conversation
postQualitySurveys 1 param → 200400401403404408409413
GET
/api/v2/quality/forms/{formId}deprecated
Get an evaluation form
getQualityForm 1 param → 200400401403404408409413
PUT
/api/v2/quality/forms/{formId}deprecated
Update an evaluation form.
putQualityForm 2 params → 200400401403404408409413
DELETE
/api/v2/quality/forms/{formId}deprecated
Delete an evaluation form.
deleteQualityForm 1 param → 200400401403404408409413
GET
/api/v2/quality/forms/{formId}/versionsdeprecated
Gets all the revisions for a specific evaluation.
getQualityFormVersions 4 params → 200400401403404408409413
GET
/api/v2/quality/formsdeprecated
Get the list of evaluation forms. If you set "expand=publishHistory", then you will be able to get published versions for each corresponding evaluation form.
getQualityForms 8 params → 200400401403404408409413
POST
/api/v2/quality/formsdeprecated
Create an evaluation form.
postQualityForms 1 param → 200400401403404408409413
GET
/api/v2/quality/publishedforms/{formId}deprecated
Get the published evaluation forms.
getQualityPublishedform 1 param → 200400401403404408409413
GET
/api/v2/quality/publishedformsdeprecated
Get the published evaluation forms.
getQualityPublishedforms 4 params → 200400401403404408409413
POST
/api/v2/quality/publishedformsdeprecated
Publish an evaluation form.
postQualityPublishedforms 1 param → 200400401403404408409413

Schemas 190

The contract defines 190 schemas that model the data the API accepts and returns. The most detailed are Evaluation (43 properties), EvaluationResponse (42 properties), EvaluationSearchItemResponse (42 properties), Queue (41 properties). Each schema is shown below with its type and property counts.

Team
object
8 properties 1 required
WorkPlanBidRanks
object
4 properties
AddressableEntityRef
object
2 properties
AsyncQueryStatus
object
5 properties
ResourcePermissionPolicy
object
11 properties
PublishForm
object
2 properties 2 required
AiScoring
object
3 properties
WritableDivision
object
3 properties
StatisticalResponse
object
3 properties
EvaluationAggregationQueryMe
object
6 properties 2 required
AggregateViewData
object
2 properties
EvaluationSearchSubAggregationDTO
object
8 properties 3 required
EvaluationSearchAggregationDTO
object
8 properties 3 required
SurveyAggregateQueryResponse
object
1 property
CreateSurveyResponse
object
16 properties
UserStations
object
4 properties
Script
object
15 properties
OAuthLastTokenIssued
object
1 property
EvaluationSearchResponse
object
4 properties
QuestionSettings
object
2 properties
Queue
object
41 properties
ConditionalGroupActivationPilotRule
object
2 properties
MediaSummary
object
2 properties
StatisticalSummary
object
14 properties
EvaluationSearchRequestDTO
object
7 properties 2 required
LocationAddressVerificationDetails
object
4 properties
EvaluationEntityListing
object
10 properties
AcwSettings
object
2 properties
ExpansionCriterium
object
2 properties
DirectRoutingMediaSettings
object
1 property
SurveyAggregateQueryClause
object
2 properties 2 required
PropertyChange
object
3 properties
Geolocation
object
11 properties
EvaluationCreateCalibration
object
2 properties
AiScoringSettings
object
3 properties
EvaluationSearchAggregationBucket
object
13 properties
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
AgentScoringRule
object
13 properties 4 required
DomainEntityListingSurveyForm
object
10 properties
ConditionalGroupActivationCondition
object
3 properties
Page
object
8 properties
EvaluationReference
object
2 properties
ScorableSurvey
object
6 properties
EvaluationCreateConversation
object
2 properties
TopicDuration
object
1 property
EvaluationFormAndScoringSet
object
2 properties
AsyncQueryResponse
object
1 property
CalibrationCreate
object
16 properties 1 required
PagelessDomainEntityListingEvaluationVersion
object
3 properties
EvaluationSearchCriteriaDTO
object
7 properties 2 required
EvaluationFormSearchResponse
object
12 properties
User
object
39 properties 1 required
MediaSummaryDetail
object
2 properties
Biography
object
5 properties
AuditQuerySort
object
2 properties 2 required
EmailMediaSettings
object
5 properties
QualityAuditQueryExecutionStatusResponse
object
6 properties
AnswerOption
object
6 properties
EvaluationAggregateQueryFilter
object
3 properties 1 required
ResourceConditionNode
object
5 properties
ConditionalGroupActivation
object
2 properties
SurveyScoringSet
object
3 properties
EvaluationQuestion
object
14 properties
NumericRange
object
4 properties
EvaluationQuestionGroupScore
object
16 properties
SurveyAsyncAggregateQueryResponse
object
2 properties
MessageSubtypeSettings
object
2 properties
AgentActivityEntityListing
object
10 properties
EmailAddress
object
2 properties
EvaluationQuestionScore
object
10 properties
DomainEntityRef
object
3 properties
SurveyQuestionScore
object
9 properties
EvaluationFormResponseEntityListing
object
10 properties
EvaluationAggregateQueryClause
object
2 properties 2 required
EvaluationVersion
object
3 properties
EvaluationAggregateQueryResponse
object
1 property
SurveyForm
object
12 properties 3 required
AiAnswer
object
3 properties
EvaluationAsyncAggregationQuery
object
10 properties 2 required
EvaluationAggregationQuery
object
9 properties 2 required
EvaluationSettingsAssignee
object
2 properties
QueueMessagingAddresses
object
3 properties
SurveyFormAndScoringSet
object
2 properties
InactivityTimeoutSettings
object
3 properties
EvaluationAsyncAggregateQueryResponse
object
2 properties
DomainRole
object
2 properties
Calibration
object
16 properties
SurveyQuestionGroup
object
7 properties
ServiceLevel
object
2 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
PresenceDefinition
object
3 properties
Signature
object
4 properties
FlowDiagnosticInfo
object
1 property
MemberGroup
object
6 properties
Detail
object
4 properties
EvaluatorActivityEntityListing
object
10 properties
UserAuthorization
object
4 properties
EvaluationScoringSet
object
11 properties
QuestionGroupSettings
object
2 properties
SurveyAggregateQueryFilter
object
3 properties 1 required
DefaultAnswersTo
object
4 properties
OutOfOffice
object
8 properties
UserPresence
object
10 properties
LocationEmergencyNumber
object
3 properties
AiScoringSetting
object
1 property
DirectRouting
object
6 properties
EvaluationSearchItemResponse
object
42 properties
QualityAuditQueryFilter
object
2 properties 2 required
SurveyAggregationView
object
4 properties 3 required
EmployerInfo
object
4 properties
SkillsToRemove
object
3 properties
AgentScoringRuleEntityListing
object
10 properties
AggregateMetricData
object
3 properties
RoutingStatus
object
3 properties
RoutingRule
object
3 properties
SurveyAggregationQuery
object
9 properties 2 required
ResourceConditionValue
object
2 properties
EvaluationFormResponse
object
13 properties 1 required
Survey
object
15 properties
EvaluationCreateBody
object
19 properties
InboundRoute
object
19 properties 2 required
EvaluationResponse
object
42 properties
QueryApiSearchAggregationRange
object
2 properties
SurveyQuestion
object
10 properties
AgentEvaluatorActivity
object
8 properties
CallbackMediaSettings
object
18 properties
QualityAuditQueryExecutionResultsResponse
object
4 properties
Limit
object
3 properties
MessageInfo
object
4 properties
SurveyAsyncAggregationQuery
object
10 properties 2 required
SurveyQuestionGroupScore
object
6 properties
Chat
object
1 property
GroupContact
object
5 properties 3 required
EvaluationAggregationView
object
4 properties 3 required
QueueReference
object
2 properties
EvaluationQuestionGroup
object
12 properties
Contact
object
7 properties
QueueEmailAddress
object
2 properties
LocationDefinition
object
16 properties
AgentOwnedRouting
object
3 properties
UserConversationSummary
object
8 properties
Actions
object
1 property
Image
object
2 properties
TranscriptTopic
object
9 properties
CalibrationEntityListing
object
10 properties
EvaluationCreateEvalForm
object
2 properties
EvaluationForm
object
12 properties 2 required
Education
object
5 properties
ConditionalGroupRoutingRule
object
6 properties
UserReferenceWithName
object
3 properties
AssistanceCondition
object
2 properties
EvaluationSearchAggregationResponse
object
9 properties
Bullseye
object
1 property
QMAuditQueryRequest
object
3 properties 2 required
ErrorBody
object
11 properties
LocationImage
object
2 properties
Division
object
3 properties
EvaluationAggregateDataContainer
object
2 properties
VisibilityCondition
object
2 properties
ConversationReference
object
2 properties
TopicOffset
object
2 properties
ConditionalGroupActivationSimpleMetric
object
2 properties
AgentActivity
object
14 properties
EvaluationCreateUser
object
2 properties 1 required
EvaluationSettings
object
4 properties
ConditionalGroupRouting
object
1 property
MediaSettings
object
5 properties
SurveyFormEntityListing
object
10 properties
EvaluationAggregateQueryPredicate
object
5 properties
QualityAuditLogMessage
object
16 properties
UserStation
object
8 properties
ConditionalGroupActivationRule
object
3 properties
CreateSurveyRequest
object
4 properties 2 required
MessageMediaSettings
object
8 properties
Group
object
17 properties 4 required
DefaultAnswer
object
2 properties
Evaluation
object
43 properties
Location
object
5 properties
SurveyAggregateQueryPredicate
object
5 properties
EvaluationSource
object
4 properties
QueueMediaSettings
object
5 properties
EvaluationCreateQueue
object
2 properties
EvaluatorActivity
object
11 properties
SurveyErrorDetails
object
2 properties
SurveyAggregateDataContainer
object
2 properties
CannedResponseLibraries
object
2 properties
AggregationRange
object
2 properties
LocationAddress
object
7 properties
Ring
object
3 properties
DomainEntityListingEvaluationForm
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-quality-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys Quality API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.