Skip to main content
Activity Logs

List Activity Logs

GET/v4/audit/platform/admin/logs

Lists the Activity Logs of the organisation, the newest first, one page at a time: the sign-ins of the administrators (also the refused sign-ins and the locked accounts), the calls that change data (each method except GET; a request that changes nothing, such as Create SSE ticket, has no entry), the webhooks that the platform sends, and the changes that a platform admin makes to the organisation (OrgUpdates entries). An entry holds no e-mail address: userName is the display name of the actor at the time of the read.

Use logType to keep only some types, and offset and limit to page through the list. auditLogsStats counts all the entries of the organisation, whatever the filter and the page.

No operation deletes an entry: the platform deletes the entries after the retention period of the installation (30 days by default). An API key with the older scope audit can also call this operation.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:audit-logs:read

Query parameters

  • offsetinteger

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    At least 0.

    Default:0

  • limitinteger

    Maximum number of records to return per page.

    Default:10

  • logTypestring

    Type of the entries: 1 Security, 2 API calls, 3 OrgUpdates, 4 UserUpdates, 5 Webhooks. Repeat the parameter, or separate the types with commas, for more than one type. The service ignores a value that is not a whole number of 1 or more. Without a usable value, the response has the entries of each type.

    Example:"1,3"

Response

application/json

The entries on the page, the pagination data and the number of entries of each type.

  • logsobject[]

    The entries on this page, the newest first.

  • paginationobject
  • auditLogsStatsobject

    The number of entries of the organisation for each type, for all the entries (not only the filtered page). All 0 when the service cannot count them.