Export data from Klaus

Need to compare Klaus data with your own metrics? It's as easy as ABC by exporting it via our API

Daniel Figueiredo avatar
Written by Daniel Figueiredo
Updated over a week ago

Role: Admin, Account Manager

First, if you haven't already, go ahead and set up an API connection in your Klaus account. You will need the API token, account ID and workspace ID from that step to continue.

How to export data with API?

With the API token, account ID and workspace ID acquired, we can make a GET request to /api/v1/payment/42000/workspace/11759/reviews by setting the token as a Bearer token in the Authorization header.

An example request with curl would look like this:

curl 'https://kibbles.klausapp.com/api/v2/account/<account_id>/workspace/<workspace_id>/reviews?fromDate=2020-01-01T00%3A00%3A00%2B00%3A00&toDate=2020-03-31T00%3A00%3A00%2B00%3A00' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_API_TOKEN'
  • For an account-wide export, you can use our /api/v2/account/<account_id>/reviews endpoint

  • Both endpoints also accept page and pageSize parameters for pagination
    ​
    ​
    ​

The structure of the response:

{
"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
}
}


Please refer to our public API's specification page for all the available query parameters, including filtering by scorecard tags, comment hashtags, and more.

Did this answer your question?