Skip to main content

Get audit logs

GET 
/v2/audit/logs

Retrieves a page of audit events.

Required scope

auditlogs:read

Rate limiting

Level 2

Request​

Query Parameters

    createdAfter daterequired

    Retrieve audit logs created after the date and time provided. This is the start date of the duration for which you want to retrieve audit logs. For example, if you want to retrieve audit logs between 2023-03-30T17:26:50.000Z and 2023-04-30T17:26:50.000Z, provide 2023-03-30T17:26:50.000Z as the value for the createdAfter parameter.
    Format: UTC, adheres to ISO 8601, including milliseconds and a trailing Z offset."

    Example: 2023-03-30T17:26:50.000Z
    createdBefore daterequired

    Retrieve audit logs created before the date and time provided. This is the end date of the duration for which you want to retrieve audit logs. For example, if you want to retrieve audit logs between 2023-03-30T17:26:50.000Z and 2023-04-30T17:26:50.000Z, provide 2023-04-30T17:26:50.000Z as the value for the createdBefore parameter.
    Format: UTC, adheres to ISO 8601, including milliseconds and a trailing Z offset.

    Example: 2023-04-30T17:26:50.000Z
    cursor string

    A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next set of results of the collection, set the cursor parameter in your next request to the appropriate cursor value returned in the response.

    limit integer

    Maximum number of results returned based on the limit specified in the request. For example, if there are 30 results, the request has no cursor value, and the limit is set to 20,the size of the results will be 20. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the cursor parameter value that you obtained from the response.
    Default: 100

    Example: 100
    sorting string

    Possible values: [ASC, DESC]

    Sort order in which you want to view the result set. Based on the value you provide, the results are sorted in an ascending or descending order of the audit log creation date (audit log createdAt parameter).
    Default: ASC

    Example: ASC

Responses​

Audit logs fetched

Schema

    type string

    Type of the response, in this case it's always 'cursor-list'

    limit integer

    Page limit

    size integer

    Item count in current page

    cursor string

    The key that should be used as the cursor request parameter to fetch the next page

    content

    object[]

    Audit events list

  • Array [

    • id string

    Audit event id

    context

    object

    Audit context

    ip string

    Ip address associated with the audit context

    team

    object

    Team associated with the audit context

    id string

    Id of the team

    name string

    Name of the team

    organization

    object

    Organization associated with the audit context

    id string

    Id of the organization

    name string

    Name of the organization

    object

    object

    The object related with the audit event

    id string

    Id of the object

    name string

    Name of the object

    createdAt date-time

    Time when the audit event has been created

    details object

    Details json related to the audit event

    createdBy

    object

    The details regarding the creator of the audit event

    type string

    Possible values: [user, application, scim_provisioner, miro_automation]

    Type of the creator

    id string

    Id of the creator

    name string

    Name of the creator

    email string

    Email of the creator

    event string

    Event type of the audit event

  • ]

Loading...