{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Quality API", "version": "v2" }, "items": [ { "info": { "name": "Quality", "type": "folder" }, "items": [ { "info": { "name": "Query for evaluation aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/query" }, "docs": "Query for evaluation aggregates" }, { "info": { "name": "Query for evaluation aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs" }, "docs": "Query for evaluation aggregates asynchronously" }, { "info": { "name": "Get status for async query for evaluation aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for evaluation aggregates" }, { "info": { "name": "Delete/cancel an async request for evaluation aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for evaluation aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/evaluations/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Query for survey aggregates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/query" }, "docs": "Query for survey aggregates" }, { "info": { "name": "Query for survey aggregates asynchronously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs" }, "docs": "Query for survey aggregates asynchronously" }, { "info": { "name": "Get status for async query for survey aggregates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Get status for async query for survey aggregates" }, { "info": { "name": "Delete/cancel an async request for survey aggregates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Delete/cancel an async request for survey aggregates" }, { "info": { "name": "Fetch a page of results for an async aggregates query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/analytics/surveys/aggregates/jobs/:jobId/results", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor token to retrieve next page" } ] }, "docs": "Fetch a page of results for an async aggregates query" }, { "info": { "name": "Get a survey as an end-customer, for the purposes of scoring it.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/surveys/scorable", "params": [ { "name": "customerSurveyUrl", "value": "", "type": "query", "description": "customerSurveyUrl" } ] }, "docs": "Get a survey as an end-customer, for the purposes of scoring it." }, { "info": { "name": "Update a survey as an end-customer, for the purposes of scoring it.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/surveys/scorable", "params": [ { "name": "customerSurveyUrl", "value": "", "type": "query", "description": "customerSurveyUrl" } ] }, "docs": "Update a survey as an end-customer, for the purposes of scoring it." }, { "info": { "name": "Gets a list of Agent Activities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/agents/activity", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "startTime", "value": "", "type": "query", "description": "Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, { "name": "endTime", "value": "", "type": "query", "description": "End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, { "name": "agentUserId", "value": "", "type": "query", "description": "user id of agent requested" }, { "name": "evaluatorUserId", "value": "", "type": "query", "description": "user id of the evaluator" }, { "name": "name", "value": "", "type": "query", "description": "name" }, { "name": "group", "value": "", "type": "query", "description": "group id" }, { "name": "agentTeamId", "value": "", "type": "query", "description": "team id of agents requested" }, { "name": "formContextId", "value": "", "type": "query", "description": "shared id between form versions" }, { "name": "userState", "value": "", "type": "query", "description": "'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. \n'Any' fetches users of 'active', 'inactive' and 'deleted' states." } ] }, "docs": "Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and" }, { "info": { "name": "Get an Agent Scoring Rule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/programs/:programId/agentscoringrules/:ruleId", "params": [ { "name": "programId", "value": "", "type": "path", "description": "Program ID from Speech and Text Analytics" }, { "name": "ruleId", "value": "", "type": "path", "description": "Agent Scoring Rule ID" } ] }, "docs": "Get an Agent Scoring Rule" }, { "info": { "name": "Update an Agent Scoring Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/programs/:programId/agentscoringrules/:ruleId", "params": [ { "name": "programId", "value": "", "type": "path", "description": "Program ID from Speech and Text Analytics" }, { "name": "ruleId", "value": "", "type": "path", "description": "Agent Scoring Rule ID" } ] }, "docs": "Update an Agent Scoring Rule" }, { "info": { "name": "Delete an Agent Scoring Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/quality/programs/:programId/agentscoringrules/:ruleId", "params": [ { "name": "programId", "value": "", "type": "path", "description": "Program ID from Speech and Text Analytics" }, { "name": "ruleId", "value": "", "type": "path", "description": "Agent Scoring Rule ID" } ] }, "docs": "Delete an Agent Scoring Rule" }, { "info": { "name": "Get Agent Scoring Rules for a program", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/programs/:programId/agentscoringrules", "params": [ { "name": "programId", "value": "", "type": "path", "description": "Program ID from Speech and Text Analytics" } ] }, "docs": "Get Agent Scoring Rules for a program" }, { "info": { "name": "Create an Agent Scoring Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/programs/:programId/agentscoringrules", "params": [ { "name": "programId", "value": "", "type": "path", "description": "Program ID from Speech and Text Analytics" } ] }, "docs": "Creates a new Agent Scoring Rule for AI-powered automated evaluation of agent interactions. The rule defines how interactions should be selected and evaluated using the specified evaluation form." }, { "info": { "name": "Get a calibration by id. Requires either calibrator id or conversation id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/calibrations/:calibrationId", "params": [ { "name": "calibrationId", "value": "", "type": "path", "description": "Calibration ID" }, { "name": "calibratorId", "value": "", "type": "query", "description": "calibratorId" }, { "name": "conversationId", "value": "", "type": "query", "description": "conversationId" } ] }, "docs": "Get a calibration by id. Requires either calibrator id or conversation id" }, { "info": { "name": "Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/calibrations/:calibrationId", "params": [ { "name": "calibrationId", "value": "", "type": "path", "description": "Calibration ID" } ] }, "docs": "Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex" }, { "info": { "name": "Delete a calibration by id.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/quality/calibrations/:calibrationId", "params": [ { "name": "calibrationId", "value": "", "type": "path", "description": "Calibration ID" }, { "name": "calibratorId", "value": "", "type": "query", "description": "calibratorId" } ] }, "docs": "Delete a calibration by id." }, { "info": { "name": "Get the list of calibrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/calibrations", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "conversationId", "value": "", "type": "query", "description": "conversation id" }, { "name": "startTime", "value": "", "type": "query", "description": "Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, { "name": "endTime", "value": "", "type": "query", "description": "end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, { "name": "calibratorId", "value": "", "type": "query", "description": "user id of calibrator" } ] }, "docs": "NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch." }, { "info": { "name": "Create a calibration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/calibrations", "params": [ { "name": "expand", "value": "", "type": "query", "description": "calibratorId" } ] }, "docs": "Create a calibration" }, { "info": { "name": "Get results of audit query", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/conversations/audits/query/:transactionId/results", "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Transaction ID" }, { "name": "cursor", "value": "", "type": "query", "description": "Indicates where to resume query results (not required for first page)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand" } ] }, "docs": "Get results of audit query" }, { "info": { "name": "Create audit query execution", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/conversations/audits/query" }, "docs": "Create audit query execution" }, { "info": { "name": "Get status of audit query execution", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/conversations/audits/query/:transactionId", "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Transaction ID" } ] }, "docs": "Get status of audit query execution" }, { "info": { "name": "Get an evaluation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/conversations/:conversationId/evaluations/:evaluationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "evaluationId", "value": "", "type": "path", "description": "evaluationId" }, { "name": "expand", "value": "", "type": "query", "description": "agent, assignee, evaluator, evaluationForm" } ] }, "docs": "Get an evaluation" }, { "info": { "name": "Update an evaluation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/conversations/:conversationId/evaluations/:evaluationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "evaluationId", "value": "", "type": "path", "description": "evaluationId" }, { "name": "expand", "value": "", "type": "query", "description": "evaluatorId, evaluationForm, assignee, evaluator" } ] }, "docs": "The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint." }, { "info": { "name": "Delete an evaluation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/quality/conversations/:conversationId/evaluations/:evaluationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "evaluationId", "value": "", "type": "path", "description": "evaluationId" }, { "name": "expand", "value": "", "type": "query", "description": "evaluatorId, evaluationForm" } ] }, "docs": "Delete an evaluation" }, { "info": { "name": "Create an evaluation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/conversations/:conversationId/evaluations", "headers": [ { "name": "Idempotency-Key", "value": "" } ], "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" }, { "name": "expand", "value": "", "type": "query", "description": "evaluatorId" } ] }, "docs": "Create an evaluation" }, { "info": { "name": "Get the surveys for a conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/conversations/:conversationId/surveys", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "conversationId" } ] }, "docs": "Get the surveys for a conversation" }, { "info": { "name": "Query for evaluation aggregates for the current user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/evaluations/aggregates/query/me" }, "docs": "Query for evaluation aggregates for the current user" }, { "info": { "name": "Update the AI Scoring settings of an evaluation form.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations/:formId/aiscoring/settings", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Update the AI Scoring settings of an evaluation form." }, { "info": { "name": "Get an evaluation form", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Get an evaluation form" }, { "info": { "name": "Update an evaluation form.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Update an evaluation form." }, { "info": { "name": "Delete an evaluation form.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Delete an evaluation form." }, { "info": { "name": "Gets all the revisions for a specific evaluation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations/:formId/versions", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Gets all the revisions for a specific evaluation." }, { "info": { "name": "Retrieve a list of evaluation forms by their ids", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations/bulk", "params": [ { "name": "id", "value": "", "type": "query", "description": "A comma-delimited list of valid evaluation form ids. The maximum number of ids allowed in this list is 100" }, { "name": "includeLatestVersionFormName", "value": "", "type": "query", "description": "Whether to include the name of the form's most recently published version" } ] }, "docs": "Retrieve a list of evaluation forms by their ids" }, { "info": { "name": "Retrieve a list of the latest published evaluation form versions by context ids", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations/bulk/contexts", "params": [ { "name": "contextId", "value": "", "type": "query", "description": "A comma-delimited list of valid evaluation form context ids" } ] }, "docs": "Retrieve a list of the latest published evaluation form versions by context ids" }, { "info": { "name": "Get the list of evaluation forms", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "expand", "value": "", "type": "query", "description": "If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order to sort results, either asc or desc" } ] }, "docs": "By default, \"published\" field is always returned as false for all evaluation forms. If you set \"expand=publishHistory\", then you will be able to get published versions for each corresponding evaluation form.\nIn addition, \"questionGroups\", the detailed information about evaluation form, is not returned. We will enhance this field in a future release." }, { "info": { "name": "Create an evaluation form.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/forms/evaluations" }, "docs": "Create an evaluation form." }, { "info": { "name": "Queries Evaluations and returns a paged list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/evaluations/query", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "conversationId", "value": "", "type": "query", "description": "conversationId specified" }, { "name": "agentUserId", "value": "", "type": "query", "description": "user id of the agent" }, { "name": "agentTeamId", "value": "", "type": "query", "description": "team id of the agent" }, { "name": "evaluatorUserId", "value": "", "type": "query", "description": "evaluator user id" }, { "name": "assigneeUserId", "value": "", "type": "query", "description": "assignee user id" }, { "name": "queueId", "value": "", "type": "query", "description": "queue id" }, { "name": "startTime", "value": "", "type": "query", "description": "start time of the evaluation query" }, { "name": "endTime", "value": "", "type": "query", "description": "end time of the evaluation query" }, { "name": "formContextId", "value": "", "type": "query", "description": "shared id between form versions" }, { "name": "evaluationState", "value": "", "type": "query" }, { "name": "isReleased", "value": "", "type": "query", "description": "the evaluation has been released" }, { "name": "agentHasRead", "value": "", "type": "query", "description": "agent has the evaluation" }, { "name": "expandAnswerTotalScores", "value": "", "type": "query", "description": "get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request." }, { "name": "maximum", "value": "", "type": "query", "description": "the maximum number of results to return" }, { "name": "sortOrder", "value": "", "type": "query", "description": "NOTE: Does not work when conversationId is supplied." }, { "name": "includeDeletedUsers", "value": "", "type": "query", "description": "Allow returning an agent or evaluator user with a 'delete' status. Defaults to false." } ] }, "docs": "Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large numb" }, { "info": { "name": "Score evaluation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/evaluations/scoring" }, "docs": "Score evaluation" }, { "info": { "name": "Search evaluations based along specified criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/evaluations/search" }, "docs": "Search Rules:\n1. Time Range\n - Time Range: Max 3 months (required)\n2. Question Group Level Query: Use at least one field containing 'questionGroup' in name + exactly one questionGroupId\n3. Question Level Query: Use at least one field containing 'question' in name + exactly one questionId\n4. Mixed Queries: questionId alone is sufficient\n5. Search Logic:\n - Multiple criteria: AND operation\n - Multiple values per criterion: OR operation\n EXAMPLE: (agentId₁ OR agentId₂) AND (evaluatorId₁ OR " }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/evaluators/activity", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "expand", "value": "", "type": "query", "description": "variable name requested by expand list" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "startTime", "value": "", "type": "query", "description": "The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, { "name": "endTime", "value": "", "type": "query", "description": "The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z" }, { "name": "name", "value": "", "type": "query", "description": "Evaluator name" }, { "name": "permission", "value": "", "type": "query", "description": "permission strings" }, { "name": "group", "value": "", "type": "query", "description": "group id" }, { "name": "agentTeamId", "value": "", "type": "query", "description": "team id of agents to be considered" } ] }, "docs": "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." }, { "info": { "name": "Get the most recent published version of an evaluation form.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/publishedforms/evaluations/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Get the most recent published version of an evaluation form." }, { "info": { "name": "Get the published evaluation forms.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/publishedforms/evaluations", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "onlyLatestPerContext", "value": "", "type": "query", "description": "onlyLatestPerContext" } ] }, "docs": "Get the published evaluation forms." }, { "info": { "name": "Publish an evaluation form.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/publishedforms/evaluations" }, "docs": "Publish an evaluation form." }, { "info": { "name": "Get the most recent published version of a survey form.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/publishedforms/surveys/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Get the most recent published version of a survey form." }, { "info": { "name": "Get the published survey forms.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/publishedforms/surveys", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "onlyLatestEnabledPerContext", "value": "", "type": "query", "description": "onlyLatestEnabledPerContext" } ] }, "docs": "Get the published survey forms." }, { "info": { "name": "Publish a survey form.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/publishedforms/surveys" }, "docs": "Publish a survey form." }, { "info": { "name": "Get a survey form", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/surveys/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Get a survey form" }, { "info": { "name": "Update a survey form.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/forms/surveys/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Update a survey form." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/quality/forms/surveys/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "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." }, { "info": { "name": "Delete a survey form.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/quality/forms/surveys/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Delete a survey form." }, { "info": { "name": "Gets all the revisions for a specific survey.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/surveys/:formId/versions", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Gets all the revisions for a specific survey." }, { "info": { "name": "Retrieve a list of survey forms by their ids", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/surveys/bulk", "params": [ { "name": "id", "value": "", "type": "query", "description": "A comma-delimited list of valid survey form ids" } ] }, "docs": "Retrieve a list of survey forms by their ids" }, { "info": { "name": "Retrieve a list of the latest form versions by context ids", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/surveys/bulk/contexts", "params": [ { "name": "contextId", "value": "", "type": "query", "description": "A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100." }, { "name": "published", "value": "", "type": "query", "description": "If true, the latest published version will be included. If false, only the unpublished version will be included." } ] }, "docs": "Retrieve a list of the latest form versions by context ids" }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/surveys", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "expand", "value": "", "type": "query", "description": "If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order to sort results, either asc or desc" } ] }, "docs": "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." }, { "info": { "name": "Create a survey form.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/forms/surveys" }, "docs": "Create a survey form." }, { "info": { "name": "Get a survey for a conversation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/surveys/:surveyId", "params": [ { "name": "surveyId", "value": "", "type": "path", "description": "surveyId" } ] }, "docs": "Get a survey for a conversation" }, { "info": { "name": "Score survey", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/surveys/scoring" }, "docs": "Score survey" }, { "info": { "name": "Create a survey for a conversation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/surveys" }, "docs": "Create a survey for a conversation" }, { "info": { "name": "Get an evaluation form", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Get an evaluation form" }, { "info": { "name": "Update an evaluation form.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/quality/forms/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Update an evaluation form." }, { "info": { "name": "Delete an evaluation form.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/quality/forms/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Delete an evaluation form." }, { "info": { "name": "Gets all the revisions for a specific evaluation.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms/:formId/versions", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Gets all the revisions for a specific evaluation." }, { "info": { "name": "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.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/forms", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The total page size requested" }, { "name": "pageNumber", "value": "", "type": "query", "description": "The page number requested" }, { "name": "sortBy", "value": "", "type": "query", "description": "variable name requested to sort by" }, { "name": "nextPage", "value": "", "type": "query", "description": "next page token" }, { "name": "previousPage", "value": "", "type": "query", "description": "Previous page token" }, { "name": "expand", "value": "", "type": "query", "description": "If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Order to sort results, either asc or desc" } ] }, "docs": "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." }, { "info": { "name": "Create an evaluation form.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/forms" }, "docs": "Create an evaluation form." }, { "info": { "name": "Get the published evaluation forms.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/publishedforms/:formId", "params": [ { "name": "formId", "value": "", "type": "path", "description": "Form ID" } ] }, "docs": "Get the published evaluation forms." }, { "info": { "name": "Get the published evaluation forms.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/quality/publishedforms", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "onlyLatestPerContext", "value": "", "type": "query", "description": "onlyLatestPerContext" } ] }, "docs": "Get the published evaluation forms." }, { "info": { "name": "Publish an evaluation form.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/quality/publishedforms" }, "docs": "Publish an evaluation form." } ] } ], "bundled": true }