Exporting data from Zendesk QA

<div class="article-banners">
<div id="docs-wmp-link"><a href="https://support.zendesk.com/hc/en-us/articles/5411234991258-plan" target="_blank" rel="noopener noreferrer">What's my plan?</a></div>
<div class="article-banner" id="addon_zqa"><figure class="wysiwyg-table wysiwyg-table-align-left"><table style="margin-left: 0px; margin-right: auto;"><tbody><tr>
<td><strong>Add-on</strong></td>
<td>Quality Assurance (QA) or Workforce Engagement Management (WEM)</td>
</tr></tbody></table></figure></div>
</div><p>This article describes how to export data from Zendesk QA using the API. Exporting data allows you to analyze and review customer interactions outside of the Zendesk QA platform.</p><p>Admins can set up an API connection in Zendesk QA.</p><p>This article contains the following sections:</p><ul>
<li data-list-item-id="e5d6d4cc1d4c2913d363914aff56efd53"><a href="#setting-up-api-connection">Setting up an API connection</a></li>
<li data-list-item-id="eb395f26dba664c8f2e297735995858ee"><a href="#exporting-data-with-api">Exporting data with API</a></li>
<li data-list-item-id="e0e807e2a5d55ad8fd92683cf5ab3c23e"><a href="#response-structure">Response structure</a></li>
</ul><h2 id="setting-up-api-connection">Setting up an API connection</h2><p class="no-margin">To export data, you first need to set up an <a href="https://support.zendesk.com/hc/en-us/articles/7043669282714" target="_blank" rel="noopener noreferrer">API connection</a> in your Zendesk QA account. You will need the API token, account ID, and workspace ID from that step to continue.</p><h2 id="exporting-data-with-api">Exporting data with API</h2><p>The <a href="https://pub.klausapp.com/?urls.primaryName=Public%20Export%20API#/PublicExportApi/PublicExportApi_AccountReviewsV2API" target="_blank" rel="noopener noreferrer">Zendesk QA (formerly Klaus) Public Export API reference guide</a> lists the available exportable data. Data related to reviews can be exported, excluding <a href="https://support.zendesk.com/hc/en-us/articles/8536308081178" target="_blank" rel="noopener noreferrer">voice transcripts</a>, <a href="https://support.zendesk.com/hc/en-us/articles/7043747123354" target="_blank" rel="noopener noreferrer">AutoQA data</a>, and <a href="https://support.zendesk.com/hc/en-us/articles/7043701144858" target="_blank" rel="noopener noreferrer">data from dashboards</a>.</p><p class="no-margin"><strong>To export data using the API</strong></p><ol>
<li data-list-item-id="e8dfc7ed86a2435805b05f478885cc55e">Acquire the API token, account ID, and workspace ID from your API connection setup.</li>
<li data-list-item-id="eb705ced1d6fbfe362e1b82fcb460e8b8">Make a GET request to <code>/qa/api/export/workspace/11759/reviews</code> by setting the token as a Bearer token in the <strong>Authorization</strong> header.</li>
</ol><p>An example request with <code>curl</code> would look like this:</p><pre class="wysiwyg-code-block"><code class="language-auto">curl 'https://yoursubdomain.zendesk.com/qa/api/export/workspace/reviews?fromDate=2020-01-01T00%3A00%3A00%2B00%3A00&amp;toDate=2020-03-31T00%3A00%3A00' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_API_TOKEN'</code></pre><ul>
<li data-list-item-id="e03c0f740d2d977d0f9e084a013bdc7c3">For an account-wide export, you can use our <code>/qa/api/export/reviews</code> endpoint.</li>
<li data-list-item-id="e9fd446672f7202a4091155de09113542">Both endpoints also accept <code>page</code> and <code>pageSize</code> parameters for pagination.</li>
</ul><h2 id="response-structure">Response structure</h2><details><h2 id="h_01J445XN44NN6D66SBRMAM9JW2">The structure of the response:</h2>
<div class="collapsible-section-content"><pre class="wysiwyg-code-block"><code class="language-auto">{
"conversations": [
{
"externalId": "string",
"url": "string",
"externalUrl": "string",
"lastUpdated": "string",
"reviews": [
{
"id": "string",
"reviewer": {
"email": "string",
"name": "string",
"avatar": "string"
},
"reviewee": {
"email": "string",
"name": "string",
"avatar": "string"
},
"score": 0,
"ratings": [
{
"categoryId": "string",
"categoryName": "string",
"score": 0,
"weight": 0,
"critical": true,
"cause": "string"
}
],
"comment": "string",
"thread": [
{
"id": "string",
"owner": {
"email": "string",
"name": "string",
"avatar": "string"
},
"comment": "string",
"created": "string",
"updated": "string",
"thread": [
"string"
],
"tags": [
{
"tag": "string",
"user": {
"email": "string",
"name": "string",
"avatar": "string"
}
}
]
}
],
"tags": [
{
"tag": "string",
"user": {
"email": "string",
"name": "string",
"avatar": "string"
}
}
],
"created": "string",
"updated": "string",
"received": true,
"reviewTime": "string",
"scorecard": {
"id": "string",
"name": "string"
}
}
],
"comments": [
{
"id": "string",
"owner": {
"email": "string",
"name": "string",
"avatar": "string"
},
"comment": "string",
"created": "string",
"updated": "string",
"thread": [
"string"
],
"tags": [
{
"tag": "string",
"user": {
"email": "string",
"name": "string",
"avatar": "string"
}
}
]
}
],
"workspaceId": "string"
}
],
"pagination": {
"page": 0,
"pageSize": 0,
"total": 0
}
}</code></pre></div></details><p class="no-margin"> </p><div class="note">
<span class="notetitle">Note:</span> <code>externalId</code> in <a href="https://pub.klausapp.com/?urls.primaryName=Public%20Export%20API" target="_blank" rel="noopener noreferrer">Zendesk QA's Public Export API reference guide</a> corresponds to the <code>ticket_id</code> ID in <a href="https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#parameters-1" target="_blank" rel="noopener noreferrer">Zendesk Support</a>. </div><p> </p><script id="docs-schema-markup" type="application/ld+json">{
"@context": "https://schema.org",
"@type": "TechArticle",
"@id": "https://support.zendesk.com/hc/en-us/articles/7043724806810",
"url": "https://support.zendesk.com/hc/en-us/articles/7043724806810-Exporting-data-from-Zendesk-QA",
"headline": "Exporting data from Zendesk QA",
"description": "You can export review-related data from the Quality Assurance platform using an API connection by setting up the connection and making authorized GET requests to specific endpoints for data retrieval.",
"articleSection": "Integrating Zendesk QA",
"datePublished": "2024-04-10T01:22:47+00:00",
"dateModified": "2025-11-12T15:40:25+00:00",
"inLanguage": "en-US",
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "https://support.zendesk.com/hc/en-us/articles/7043724806810"
},
"author": {
"@type": "Organization",
"name": "Zendesk",
"@id": "https://www.zendesk.com"
},
"publisher": {
"@type": "Organization",
"name": "Zendesk",
"@id": "https://www.zendesk.com"
},
"isPartOf": {
"@type": "WebSite",
"name": "Zendesk Help",
"@id": "https://support.zendesk.com/hc/"
},
"about": {
"@type": "SoftwareApplication",
"name": "Zendesk",
"@id": "https://www.zendesk.com",
"softwareAddOn": {
"@type": "SoftwareApplication",
"name": "Quality Assurance",
"@id": "https://support.zendesk.com/hc/en-us/sections/6999625340058"
}
}
}</script>