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

Activities

Resource Fields

Name Type Read-only Description
activity string An identifier for the activity. create_case, update_case etc. Should contain a-Z and underscore.
actor Actor Who did it. The user/system that carried out this activity
verb string What they did. Create, Share, Join, Like, Notify etc.
summary string
actions Actions
object Object Activity performed on. Conversation, Team, Event etc.
object_actor Actor If this activity's object is itself another activity, this property specifies the original activity's actor
location Location
place Place Where the activity was carried out
target Target Describes object targetted by activity
result Result Describes the result of the activity
in_reply_to InReplyTo Identifying an object which can be considered as a response to the base object
participant Participant
portal string
weight float Weight decides the priority/importance of this activity
ip_address string
created_at timestamp ISO-8601 Format

Actions

RESOURCE FIELDS

Name Type Read-only Description
action string
CREATED, UPDATED, DELETED
field string
old_value string
new_value string
old_object Resource
new_object Resource

Actor

RESOURCE FIELDS

Name Type Read-only Description
name string
titile string
prefix string
url string
full_title string
image string
preposition string
original Resource

Object

RESOURCE FIELDS

Name Type Read-only Description
name string
titile string
prefix string
url string
full_title string
image string
preposition string
original Resource

Place

RESOURCE FIELDS

Name Type Read-only Description
name string
titile string
prefix string
url string
full_title string
image string
preposition string
original Resource

Target

RESOURCE FIELDS

Name Type Read-only Description
name string
titile string
prefix string
url string
full_title string
image string
preposition string
original Resource

Result

RESOURCE FIELDS

Name Type Read-only Description
name string
titile string
prefix string
url string
full_title string
image string
preposition string
original Resource

InReplyTo

RESOURCE FIELDS

Name Type Read-only Description
name string
titile string
prefix string
url string
full_title string
image string
preposition string
original Resource

Participant

RESOURCE FIELDS

Name Type Read-only Description
name string
titile string
prefix string
url string
full_title string
image string
preposition string
original Resource

Location

RESOURCE FIELDS

Name Type Read-only Description
city string
region string
region_code string
area_code string
time_zone string
organization string
net_speed string
The network speed associated with the IP address.
country string
country_code string
postal_code string
latitude string
longitude string
metro_code string
The metro code associated with the IP address.
These are only available for IP addresses in the US.
isp string
The name of the Internet Service Provider associated with the IP address.



Metadata




 
 



Version 1.0
Last Updated January 13, 2017

Actions

Retrieve activities

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

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope conversations
Ordered by created_at (ascending)

Arguments

Name Type Mandatory Description
minimum_weight float Filter activities by their minimum weight
since timestamp Filter activities newer than specified date
until timestamp Filter activities older than specified date
sort_order string ASC, DESC

Default: DESC

Response

    {
        "status": 200,
        "data": [
            {
    "id": 12,

    "activity": "create_case",
    "actor": {
    "name": "user",
    "title": "Simon Blackhouse",
    "prefix": "@",
    "url": "https://brewfictus.kayako.com/user/1",
    "full_title": "Simon Blackhouse",
    "image": "",
    "preposition": null,
    "original": 



{
    "id": 1,

    "resource_type": "user"

}
,
    "resource_type": "activity_actor"
}
,
    "verb": "create",
    "summary": "<@https://brewfictus.kayako.com/user/1|Phoebe Todd> created <https://brewfictus.kayako.com/case/view/1|Atmosphere Coffee, Inc annual maintenance>",
    "actions": [],
    "object": {
    "id": 1,

    "resource_type": "case"

}
,
    "object_actor": null,
    "location": null,
    "place": null,
    "target": null,
    "result": null,
    "in_reply_to": null,
    "participant": null,
    "portal": "API",
    "weight": 0.8,
    "ip_address": null,
    "created_at": "2015-07-27T11:35:09+05:00",

    "resource_type": "activity"
}

        ],
        "resource": "activity",
        "limit": 10,
        "total_count": 1
    }