SAsalesforce
auditEvents

Find auditEvents

Changed on

Find auditEvents. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response.

get/auditEvents

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/auditEvents
  • Auth
    API key in header Authorization

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=loggedAt'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-loggedAt'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

startAtstring

Filter by auditEvent loggedAt timestamp range (https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14). Cannot combine startAt/endAt with relativeDateTime.

endAtstring

Filter by auditEvent loggedAt timestamp range (https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14). Cannot combine startAt/endAt with relativeDateTime.

relativeDateTimestring

Filter by auditEvent loggedAt timestamp using relative date/time, e.g. "-12h" for the last twelve hours, "-15m" for the last fifteen minutes, etc. Cannot combine startAt/endAt with relativeDateTime.

resourceTypestring

Filter by auditEvent resourceType; asterisk (*) wildcards ok.

resourceNamestring

Filter by auditEvent resourceName; asterisk (*) wildcards ok.

isErrorboolean

Filter by auditEvent isError.

createdAtstring

Filter by time period when AuditEvents were created.

updatedAtstring

Filter by time period when AuditEvents were updated.

Response

Success, returns a list of auditEvents.

detailsobject

A JSON object with additional event details.

idstring

The auditEvent id.

loggedAtstring

The timestamp when the event was logged.

isErrorboolean

True if this audit event represents an error.

resourceNamestring

The name of the resource associated with this event.

resourceTypestring

The type of the resource associated with this event, e.g. "Collector", "Subject", etc.

createdBystring

Id of the User/Collector who created this auditEvent.

createdAtstring

Timestamp when the record was saved to Refocus. Due to latency and queuing, this value is expected to be greater than the loggedAt timestamp.

Changes

  • v161c43b67559bRevision changes
    • info

      added the new optional query request parameter createdAt

    • info

      added the new optional query request parameter updatedAt