List Events

GET {{baseUrl}}/logs?activityType=anim consequa&organizationId=dolore deserunt magna&userId=exercitation dolore anim dolor&directoryId=ex aliqua laborum reprehenderit&groupId=et deserunt in&contactId=cupidatat sed&pageSize=100&order=asc&skipToken=minim amet&startDate=1984-04-30T10:19:49.307Z&endDate=2013-11-01T09:17:12.909Z

Retrieve the collection of events by activity type and time interval.

Activity Types

Due to the different types of activities represented here, not every activityType query param will function on every query. To determine the activityType query parameters that can be used, see the Get Activity Log endpoint (see: List Activity Types).

Request Params

KeyDatatypeRequiredDescription
activityTypestring(Required) The type of audit event for which you want the logs
organizationIdstringThe brand you want to search for
userIdstringThe user you want to search for
directoryIdstringAn internal globally unique identifier for a Directory
groupIdstringAn internal globally unique identifier for a Group
contactIdstringAn internal globally unique identifier for a Contact
pageSizenumberThe maximum number of events to return per request
orderstringDetermines how the events are organized/ordered in the response, can be asc or dsc
skipTokenstringIt contains the next page token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call
startDatestringThe inclusive start date to begin searching for events from. If not supplied, will default to -7 days from the end date.
endDatestringThe exclusive end date to stop searching for events at. If not supplied, will default to +7 days from the start date.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"result":{"nextPage":null,"elements":[{"id":"0ce7eda1-f815-4320-8fa7-fe0e3fd49412","timestamp":"2020-11-13T19:13:40.793Z","datacenter":"ST3","source":"login5-app.g1-iad.qops.net","descriptor":{"userId":"UR_cVcNH0elQesua8J","username":"example@gmail.com","brandId":"apidocs","sessionId":null,"isSuccessful":true,"failureReason":null,"isProxyLogin":false,"proxyDetails":null,"product":"ControlPanel","url":"https://apidocs.st3.qualtrics.com/login?path=%2FControlPanel%2F\u0026product=ControlPanel","ipAddress":"165.225.38.31","location":{"countryCode":"US","region":"NJ","city":"Hoboken","postalCode":"07030","latitude":40.742401123046875,"longitude":-74.03250122070312,"dmaCode":501,"areaCode":201,"metroCode":501},"authentication":{"method":"BASIC","methodVersion":null,"secondFactor":null},"platform":{"userAgent":"Chrome","userAgentVersion":"86.0.4240.198","operatingSystem":"OS X","operatingSystemVersion":"10.15.6","deviceFamily":"Chrome"}}}]},"meta":{"requestId":"a9a30368-f054-4da8-970a-4c3406c957d2","httpStatus":"200 - OK"}}