GOgooddata
auditEvents

List audit events for a domain

NOTE: Audit events are available only per request and may be subject to an additional charge. For more information, contact your Account Manager. <br/><br/> Returns a paged list of audit events for a specific domain. For more information about audit events, see Auditing Platform Events. <br/><br/> You must be a domain admin to perform this operation.

get/gdc/domains/{domainId}/auditEvents

Request

  • Base URL
    https://secure.gooddata.com
  • Auth
    none declared

Path parameters

domainIdstring required

The ID of the domain that you want to list audit events for.

Query parameters

offsetstring

The offset of the first returned record on a page. The offset value is the ID of an audit event. If you are making the first API call for audit events, make it without specifying offset. The returned response would contain the next parameter that has the offset key set to the ID of the last event on the page. You can use this ID as the value for the offset parameter in the subsequent API calls.

limitinteger
Example:50

The maximum number of records per page

fromstring date-time

The minimum record date to list (date from).

tostring date-time

The maximum record date to list (date to).

typestring

Type of events to list (event type). See available event types for more details.

Response

List of audit events

Example response

{
  "events": {
    "items": [
      {
        "event": {
          "id": "123-324-123",
          "userLogin": "email@gooddata.com",
          "occurred": "2019-10-29T12:37:17.689Z",
          "recorded": "2019-10-29T12:37:34Z",
          "userIp": "127.0.0.1",
          "success": true,
          "type": "LOGIN",
          "params": {
            "profileId": 123
          },
          "links": {
            "profile": "/gdc/account/profile/123"
          }
        }
      }
    ],
    "paging": {
      "next": "/gdc/link/to/auditEvents?offset=123-324-123",
      "offset": "123-324-123"
    },
    "links": {
      "self": "/gdc/link/to/auditEvents"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.