MCPDocumentationResourcesMarketplaceCommunity
API Reference
Build your app

Get audit logs

get
https://api.miro.com/v2/audit/logs

Retrieves a page of audit events within your organization's configured audit log retention period.

Required scope

auditlogs:read

Rate limiting

Level 2

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

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."

string
required

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.

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.

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

string
enum

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

Allowed:
eventTypes
array of strings
length ≤ 50

Filters results to only include events with one of the given event types. Provide multiple values as a comma-separated list (maximum 50 values). When values are combined with OR, an event with any of the given types is included. Use AND to combine with the other filter parameters (eventCategories, actorIds, objectIds). Exceeding 50 values or providing an invalid value returns a 400 response.

eventTypes
eventCategories
array of strings
length ≤ 50

Filters results to only include events in one of the given event categories. Provide multiple values as a comma-separated list (maximum 50 values). When values are combined with OR, an event with any of the given categories is included. Use AND to combine with the other filter parameters (eventTypes, actorIds, objectIds). Exceeding 50 values or providing an invalid value returns a 400 response.

eventCategories
actorIds
array of strings
length ≤ 50

Filters results to only include events performed by one of the given actor ids. Provide multiple values as a comma-separated list (maximum 50 values). When values are combined with OR, an event performed by any of the given actors is included. Use AND to combine with the other filter parameters (eventTypes, eventCategories, objectIds). Exceeding 50 values returns a 400 response.

actorIds
objectIds
array of strings
length ≤ 50

Filters results to only include events affecting one of the given object ids. Provide multiple values as a comma-separated list (maximum 50 values). When values are combined with OR, an event affecting any of the given objects is included. Use AND to combine with the other filter parameters (eventTypes, eventCategories, actorIds). Exceeding 50 values returns a 400 response.

objectIds
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?