Documentation

Activity Log API

Activity Log API Reference

The Activity Log api allows to retrieve activity log entries from your Domo instance.

Activity Log Entry Object

Attributes

Property Name Type Description
userName String The name of the user
userId String The id of the user
userType String Type of user
actorId Long Id of proxying user if applicable
actorName String Name of user performing the proxy if applicable
objectName String Name of object being affected
objectId String The ID of the object affected
objectType String The type of object affected
additionalComment String Description of the log entry, with additional information if applicable
time String The time the event took place
eventText String Text describing the main event of the log entry
device String The device type the event came from
browserDetails String The acting users browser details
ipAddress String The ip address of where the event took place

Retrieve Activity Log Entries

Retrieves activity log entries

Definition

https://api.domo.com/v1/audit

Query Params

Property Name Type Required Description
user string Optional The Id of the user
start long Required The start time(milliseconds) of when you want to receive log events
end long Optional The end time(milliseconds) of when you want to receive log events
limit long Optional The maximum number of events you want to retrieve(default is 50, maximum of 1000)
offset long Optional The offset location of events you retrieve(default is 0)

Sample Request

GET https://api.domo.com/v1/audit?user=1619916076&start= 1513230600000&end= 1513231200000&limit=50&offset=0
Content-Type: application/json
Accept: application/json
Authorization: bearer <your-valid-oauth-access-token>

Returns

Returns a list of activity log entries. If a user is provided it will just provide logs just for that user. We highly recommend using start and end times with paging(limit and offset) to retrieve large amounts of information.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json

    {
        "actionType": "VIEWED",
        "actorId": 0,
        "actorName": "",
        "additionalComment": "Leonard Euler viewed page Intro to Domo.",
        "browserDetails": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36",
        "device": "desktop",
        "eventText": "Viewed page",
        "ipAddress": "50.207.241.61",
        "objectId": "663909457",
        "objectName": "Intro to Domo",
        "objectType": "PAGE",
        "time": "2017-12-13 10:57:35 PM",
        "userId": "1619916076",
        "userName": "Leonard Euler",
        "userType": "USER"
    }