Documentation is now available for the Fall 2020 Update release!

Get activity log of an incident

This endpoint is used to retrieve user activities on an incident.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/incidents/{incidentId}/activitylog

Sample URLs

https://{api-url}/api/v2/tenants/client_4/incidents/INC0000001798/activitylog?startTs=2018-10-24T05:26:27 0000&endTs=2018-10-30T05:26:27 0000&isDescendingOrder=true

Parameters

All parameters are optional:

FieldDefault ValueDescription
startTsTicket created timeTo retrieve activities performed on an incident within a certain duration, provide the start time and end time. startTs indicates the from date and time.
Example: 2018-08-10T05:39:51 0000
endTsCurrent timeendTs indicates the to date and time.
Example: 2018-08-25T10:20:15 0000
isDescendingOrdertrueTo list the data in a descending order (high to low), provide isDescendingOrder: true, otherwise provide false. By default, data is listed in descending order.
Example: To arrange data from 30th Oct to 1st Oct, provide isDescendingOrder: true

Sample response

{
 "results": [{
 "activity": "Incident Updated notification sent by James",
 "createdTime": "2018-10-29T07:17:13+0000",
 "logType": "TICKET_NOTIFICATION",
 "createdBy": {
 "loginName": "James_Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "toList": "john.smith@myorganization.com",
 "ccList": "network.admin@myorganization.com,support@myorganization.com"
 },
 {
 "activity": "Incident "#INC0000001798 Sample Incident Network Storage" updated by James",
 "htmlLog": ["<div class="ActivityLogDetails"></div><p>Identified On changed from 2018-10-31 00:00 to 2018-10-30 18:30:00</p>",
 "<p>internal date and time changed from 2018-10-31 00:00 to 2018-10-30 18:30:00</p>"],
 "createdTime": "2018-10-29T07:17:12+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "changeLog": [{
 "attribute": "Identified On",
 "oldValue": "2018-10-31 00:00",
 "newValue": "2018-10-30 18:30:00"
 },
 {
 "attribute": "internal date and time",
 "oldValue": "2018-10-31 00:00",
 "newValue": "2018-10-30 18:30:00"
 }
 ]
 },
 {
 "activity": "Internal Response "internal response" added by James for Incident "#INC0000001798 Sample Incident Network Storage"",
 "htmlLog": ["<div class="PostReply"><span class="icon-comment"></span>internal response</div>"],
 "createdTime": "2018-10-29T07:17:11+0000",
 "logType": "TICKET_INTERNAL_RESPONSE",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 }
 },
 {
 "activity": "Incident Created or Updated notification sent by Annie",
 "createdTime": "2018-10-29T07:13:21+0000",
 "logType": "TICKET_NOTIFICATION",
 "createdBy": {
 "loginName": "James",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "toList": "john.smith@myorganization.com",
 "ccList": "network.admin@myorganization.com,support@myorganization.com"
 },
 {
 "activity": "Incident "#INC0000001798 Sample Incident Network Storage" updated by James",
 "htmlLog": ["<div class="ActivityLogDetails"><p class="AttributeName" > New response "Network storgae unavailable. The tape backup system is down." added.</p></div><p>Identified On changed from 2018-10-31 00:00 to 2018-10-30 18:30:00</p>",
 "<p>internal date and time changed from 2018-10-31 00:00 to 2018-10-30 18:30:00</p>"],
 "createdTime": "2018-10-29T07:13:18+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "changeLog": [{
 "attribute": "Identified On",
 "oldValue": "2018-10-31 00:00",
 "newValue": "2018-10-30 18:30:00"
 },
 {
 "attribute": "internal date and time",
 "oldValue": "2018-10-31 00:00",
 "newValue": "2018-10-30 18:30:00"
 }
 ]
 },
 {
 "activity": "Incident Created or Updated notification sent by James",
 "createdTime": "2018-10-29T07:11:42+0000",
 "logType": "TICKET_NOTIFICATION",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "toList": "john.smith@myorganization.com",
 "ccList": "network.admin@myorganization.com,support@myorganization.com,superadmin@myorganization.com"
 },
 {
 "activity": "Incident "#INC0000001798 Sample Incident Network Storage" updated by James",
 "htmlLog": ["<div class="ActivityLogDetails"><p class="AttributeName" >Subject changed from Network Storgae to Network Storage in SJ Unavailable</p></div>"],
 "createdTime": "2018-10-29T07:11:34+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com",
 "phoneNumber": "800 123-1234"
 },
 "changeLog": [{
 "attribute": "Subject",
 "oldValue": "Network Storage",
 "newValue": "Network Storage in SJ Unavailable"
 }]
 },
 {
 "activity": "Incident Created or Updated notification sent by James from <span style='font-weight:bold;'>Test(Custom)</span> integration",
 "createdTime": "2018-10-25T06:26:29+0000",
 "logType": "TICKET_NOTIFICATION",
 "createdBy": {
 "loginName": "James.Blake",
 "lastName": "Blake",
 "firstName": "James",
 "email": "james.blake@myorganization.com"
 },
 "toList": "john.smith@myorganization.com",
 "ccList": "network.admin@myorganization.com,support@myorganization.com,superadmin@myorganization.com"
 },
 {
 "activity": "New Incident "#INC0000001798 Network Storage" created by OpsRamp API User from <span style='font-weight:bold;'>Test(Custom)</span> integration",
 "createdTime": "2018-10-25T06:26:27+0000",
 "logType": "TICKET",
 "createdBy": {
 "loginName": "opsramp_api_user",
 "lastName": " ",
 "firstName": "OpsRamp API User",
 "email": "opsAdmin@myorganization.com"
 }
 }
 ],
 "totalResults": 9,
 "pageSize": 9,
 "nextPage": false,
 "startDate": "2018-10-24T05:26:27+0000",
 "endDate": "2018-10-30T05:26:27+0000",
 "descendingOrder": true
}