MCPDocumentationResourcesMarketplaceCommunity
API Reference
Build your app

Get AI interaction logs (Beta)

get
https://api.miro.com/v2/orgs//ai-interaction-logs

Retrieves AI interaction logs for your organization. AI interaction logs capture user interactions with AI features in Miro: the prompt received from the user, the response returned to them, and the model and tool calls made in between. You can retrieve results for a specific time period, and filter them by session, actor, affected object, or event type. Results are paginated: when more logs match than the page holds, the response carries a cursor you pass to the next request.

Required scope

aiinteractionlogs:read

Rate limiting

Level 4

Enterprise Guard only

This API is available only for Enterprise plan users with the Enterprise Guard add-on.

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

Unique identifier of the organization.

Query Params
session_ids
array of strings
length ≤ 15

Filters AI interaction logs using a list of session IDs. A session groups the events of one
conversation, so filtering by session ID returns every event of that conversation.
You can obtain session IDs from the response of this endpoint (the session.id field).

session_ids
actor_ids
array of strings
length ≤ 15

Filters AI interaction logs using a list of actor IDs. An actor is the user, or the Miro agent
acting on a user's behalf, that produced the interaction.
You can obtain actor IDs from the response of this endpoint (the actor.id field).

actor_ids
actor_emails
array of strings
length ≤ 15

Filters AI interaction logs using a list of actor emails. Only interactions associated with the
provided emails are included in the response.

actor_emails
object_ids
array of strings
length ≤ 15

List of object IDs used to retrieve AI interaction logs.
Currently, supported object types include board IDs and organization IDs.
You can obtain object IDs from the response of this endpoint (the object.id field),
from other Platform API endpoints (for example, Get boards API),
or from Miro UI URLs (board ID and organization ID from the URLs).

object_ids
event_types
array of strings
length ≤ 15

Filters AI interaction logs using a list of event types. Each event records one step of an
interaction, so filtering by event type narrows the response to those steps.

event_types
Allowed:
date-time
required

Start date and time of the time range used to filter AI interaction logs. Only interactions that were stored within the specified from - to time range are returned. The range must cover a period of at most 1 month.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset. Milliseconds are optional.

date-time
required

End date and time of the time range used to filter AI interaction logs. Only interactions that were stored within the specified from - to time range are returned. The range must cover a period of at most 1 month.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset. Milliseconds are optional.

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 portion of the collection, set the cursor parameter equal to the cursor value you received in the response of the previous request.

int32
1 to 100
Defaults to 100

The maximum number of results to return per call. If the number of logs in the response is greater than the limit specified, the response returns the cursor parameter with a value.

string
enum
Defaults to asc

Sort order in which you want to view the result set based on the interaction date. To sort by an ascending date, specify asc. To sort by a descending date, specify desc.

Allowed:
Responses

Updated 4 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 4 months ago

Did this page help you?