Cache
    Configuration
    Events

    Rate this page:

    Events

    Get a paginated list of audit events

    GET /events

    Request

    Query parameters
    from

    string

    The start timestamp in ISO8601 format

    Format: date-time
    to

    string

    The end timestamp in ISO8601 format

    Format: date-time
    offset

    string

    The number of records to skip

    Default: 0, Minimum: 0, Format: int32
    pageCursor

    string

    Location of last result returned in format of timestamp,ID. For making a request for page X, the value of this field can be obtained from pagingInfo->nextPageCursor in response for page X-1

    limit

    string

    The maximum number of records returned

    Default: 200, Minimum: 1, Maximum: 100000, Format: int32
    userIds

    string

    Audit event author identifiers separated by comma

    Style: form
    categories

    string

    Audit categories separated by comma

    Style: form
    actions

    string

    Comma-separated list of actions which triggered the audit record

    Style: form
    affectedObject

    string

    A list of affected objects separated by semicolon. Each affected object is a pair of object type and id separated by comma. Administrator permission of all affected objects is required when specified. Global administrator permission is required when no affected object is specified.

    search

    string

    Search expression, this parameter may have negative performance impact. It's recommended to use scanLimit when this parameter is specified.

    outputFormat

    string

    What format output should the server create

    Default: json
    scanLimit

    string

    The maximum number of records to be scanned in the inverse insertion order with from and to filters taking precedence, the default value is 2147483647 which means there is no limit

    Default: 2147483647, Minimum: 1, Maximum: 2147483647, Format: int32

    Example

    1
2
3
    curl --request GET \
  --url 'https://your-domain.atlassian.net/events' \
  --header 'Accept: application/json'

    Responses

    Successful operation

    Content typeValue
    application/json

    AuditEntitiesResponseJson

    text/csv

    AuditEntitiesResponseJson

    Rate this page: