Fields

Customer Feedback objects have the following fields and links:

Fields

field name description
id string identifier for this object
rating Numeric rating left by customer
rating_type Rating type used to generate this feedback, either yes_no or four_star
additonal_feedback An optional additional feedback text field
created_at Date the feedback was created
updated_at Date the feedback was updated

Links

rel class embeddable? description
self customer feedback no this customer feedback
customer customer no the recipient of this feedback
case case no the case to which this feedback is assigned
user user no the user who created this feedback

List

Retrieve a paginated list of all feedbacks.

GET https://yoursite.desk.com/api/v2/feedbacks

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Sorting

Sorting is supported on feedbacks in a filter by using sort_field and sort_direction parameters in your request.

  • sort_field - created_at or updated_at
  • sort_direction - direction to sort - asc for ascending, desc for descending

Case Filtering

Case filtering is supported by using case_id parameter in your request. It will only return feedbacks with the associated case ID.

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/feedbacks \
    -u email:password \
    -H 'Accept: application/json'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
{
  "total_entries": 2,
  "page": 1,
  "_links": {
    "self": {
      "href": "/api/v2/feedbacks?page=1&per_page=50",
      "class": "page"
    },
    "first": {
      "href": "/api/v2/feedbacks?page=1&per_page=50",
      "class": "page"
    },
    "last": {
      "href": "/api/v2/feedbacks?page=1&per_page=50",
      "class": "page"
    },
    "next": null,
    "previous": null
  },
  "_embedded": {
    "entries": [
      {
        "id": 1,
        "rating": 3,
        "rating_type": "yes_no",
        "additional_feedback": "thanks",
        "_links": {
          "self": {
            "href": "/api/v2/feedbacks/2",
            "class": "feedback"
          },
          "case": {
            "href": "/api/v2/cases/1",
            "class": "case"
          },
          "customer": {
            "href": "/api/v2/customers/1",
            "class": "customer"
          },
          "user": {
            "href": "/api/v2/users/1",
            "class": "user"
          }
        }
      },
      {
        "id": 2,
        "rating": 3,
        "rating_type": "four_star",
        "additional_feedback": "Wow you are amazing!",
        "_links": {
          "self": {
            "href": "/api/v2/feedbacks/2",
            "class": "feedback"
          },
          "case": {
            "href": "/api/v2/cases/1",
            "class": "case"
          },
          "customer": {
            "href": "/api/v2/customers/1",
            "class": "customer"
          },
          "user": {
            "href": "/api/v2/users/1",
            "class": "user"
          }
        }
      }
    ]
  }
}

Show

Retrieve a single customer feedback.

GET https://yoursite.desk.com/api/v2/feedbacks/:id

Applicable Roles

Agent, Reporting Agent, Workflow Manager, Knowledgebase Manager, Content Manager, Business Manager, Administrative Manager, Administrator, Knowledgebase Adminstrator, and Billing Administrator

Example Curl Request

1
2
3
$ curl https://yoursite.desk.com/api/v2/feedbacks/:id \
    -u email:password \
    -H 'Accept: application/json'

Example Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "id": 1,
  "rating": 3,
  "rating_type": "yes_no",
  "additional_feedback": "thanks",
  "_links": {
    "self": {
      "href": "/api/v2/feedbacks/2",
      "class": "feedback"
    },
    "case": {
      "href": "/api/v2/cases/1",
      "class": "case"
    },
    "customer": {
      "href": "/api/v2/customers/1",
      "class": "customer"
    },
    "user": {
      "href": "/api/v2/users/1",
      "class": "user"
    }
  }
}