---
title: "List interaction events"
method: GET
path: "/v1/interactions"
tags: ["interactions"]
---

# List interaction events

`GET /v1/interactions`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/interactions`
- Auth: HTTP bearer

List engagement events from your screens, such as on-screen taps, QR code scans, presenter joins, and form submissions.

**Notes.**
- Newest first, at most 1000, from screens at locations the caller can see.

## Query parameters

- `from` string
- `to` string
- `screenId` string

## Response `200`

Success.

- object
  - `data` object[], required
    - `id` string, required
    - `screenId` string, required
    - `screenName` string, required: The screen id when the screen no longer exists.
    - `at` string, required: ISO-8601 timestamp (UTC).
    - `kind` 'touch' | 'qr-scan' | 'screenshare-join' | 'form-submit', required
    - `detail` string, required: A short human-readable summary.
    - `boxId` string, nullable: A counted button tap only: the box that was tapped.
    - `creativeId` string, nullable: A counted button tap only: the design the box is on.
    - `action` string, nullable: A counted button tap only: the tap action kind (for example `open-url`).

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)