1. API
  2. v1
  3. CORE
  4. CASES

Satisfaction Ratings

Resource Fields

Name Type Read-only Description
score string GOOD, BAD
comment string
case Conversation
creator User
assignee_person User
assignee_team Team
created_at timestamp ISO-8601 Format
updated_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated January 13, 2017

Actions

Retrieve all ratings

GET /api/v1/cases/:id/ratings.json

Information

Allowed for Agents, Admins & Owners
Scope conversations

Arguments

Name Type Mandatory Description
score string GOOD, BAD
comment string true, false true returns result which contains comments false returns result without comment

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,
    "score": "GOOD",
    "comment": null,
    "case": {
    "id": 1,

    "resource_type": "case"

}
,
    "creator": 




{
    "id": 2,

    "resource_type": "user_minimal"

}
,
    "assignee_agent": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "assignee_team": {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

},
    "created_at": "2015-07-28T06:15:24+05:00",
    "updated_at": "2015-07-28T06:15:24+05:00",
    "resource_type": "rating",
    "resource_url": "https://brewfictus.kayako.com/api/v1/cases/ratings/1"
}

        ],
        "resource": "rating",
        "offset": 0,
        "limit": 10,
        "total_count": 1
    }

Retrieve recent ratings

GET /api/v1/cases/ratings/recent.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations

It's mandatory to pass the source id, i.e. either user_id or organization_id or case_id. Only one id is accepted per request.

Arguments

Name Type Mandatory Description
user_id integer
organization_id integer
case_id integer
limit string Number of recent ratings to fetch Default: 3

Response

    {
        "status": 200,
        "data": [
            {
    "id": 1,
    "score": "GOOD",
    "comment": null,
    "case": {
    "id": 1,

    "resource_type": "case"

}
,
    "creator": 




{
    "id": 2,

    "resource_type": "user_minimal"

}
,
    "assignee_agent": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "assignee_team": {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

},
    "created_at": "2015-07-28T06:15:24+05:00",
    "updated_at": "2015-07-28T06:15:24+05:00",
    "resource_type": "rating",
    "resource_url": "https://brewfictus.kayako.com/api/v1/cases/ratings/1"
}

        ],
        "resource": "rating",
        "total_count": 1
    }

Retrieve a rating

GET /api/v1/cases/:id/ratings/:id.json

Information

Allowed for Agents, Admins & Owners
Scope conversations

Response

    {
        "status": 200,
        "data": {
    "id": 1,
    "score": "GOOD",
    "comment": null,
    "case": {
    "id": 1,

    "resource_type": "case"

}
,
    "creator": 




{
    "id": 2,

    "resource_type": "user_minimal"

}
,
    "assignee_agent": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "assignee_team": {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

},
    "created_at": "2015-07-28T06:15:24+05:00",
    "updated_at": "2015-07-28T06:15:24+05:00",
    "resource_type": "rating",
    "resource_url": "https://brewfictus.kayako.com/api/v1/cases/ratings/1"
}
,
        "resource": "rating"
    }

Retrieve a rating by hash

GET /api/v1/cases/:id/ratings/:hash.json

Information

Allowed for Public
Scope conversations

Response

    {
        "status": 200,
        "data": {
    "id": 1,
    "score": "GOOD",
    "comment": null,
    "case": {
    "id": 1,

    "resource_type": "case"

}
,
    "creator": 




{
    "id": 2,

    "resource_type": "user_minimal"

}
,
    "assignee_agent": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "assignee_team": {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

},
    "created_at": "2015-07-28T06:15:24+05:00",
    "updated_at": "2015-07-28T06:15:24+05:00",
    "resource_type": "rating",
    "resource_url": "https://brewfictus.kayako.com/api/v1/cases/ratings/1"
}
,
        "resource": "rating"
    }

Add a rating

POST /api/v1/cases/:id/ratings.json

Information

Allowed for Public
Scope conversations

Only creator of the conversation is allowed to rate their conversation.

Parameters

Name Type Mandatory Description
hash string
The hash sent in rating email
score string
comment string

Response

    {
        "status": 201,
        "data": {
    "id": 1,
    "score": "GOOD",
    "comment": null,
    "case": {
    "id": 1,

    "resource_type": "case"

}
,
    "creator": 




{
    "id": 2,

    "resource_type": "user_minimal"

}
,
    "assignee_agent": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "assignee_team": {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

},
    "created_at": "2015-07-28T06:15:24+05:00",
    "updated_at": "2015-07-28T06:15:24+05:00",
    "resource_type": "rating",
    "resource_url": "https://brewfictus.kayako.com/api/v1/cases/ratings/1"
}
,
        "resource": "rating"
    }

Update a rating

PUT /api/v1/cases/:id/ratings/:id.json

Information

Allowed for Public
Scope conversations

Only creator of the conversation is allowed to update rating of their conversation.

Parameters

Name Type Mandatory Description
hash string
The hash sent in rating email
score string
comment string

Response

    {
        "status": 200,
        "data": {
    "id": 1,
    "score": "GOOD",
    "comment": null,
    "case": {
    "id": 1,

    "resource_type": "case"

}
,
    "creator": 




{
    "id": 2,

    "resource_type": "user_minimal"

}
,
    "assignee_agent": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "assignee_team": {
    "id": 1,
    "legacy_id": null,

    "resource_type": "team"

},
    "created_at": "2015-07-28T06:15:24+05:00",
    "updated_at": "2015-07-28T06:15:24+05:00",
    "resource_type": "rating",
    "resource_url": "https://brewfictus.kayako.com/api/v1/cases/ratings/1"
}
,
        "resource": "rating"
    }

Trigger rating

POST /api/v1/cases/:id/ratings/trigger.json

Information

Allowed for Agents, Admins & Owners
Scope conversations

This triggers an email to the requester of conversation asking them to rate.

Response

{
    "status": 201
}