Brix Interactions API

openapi: 3.2.0
info:
  title: Brix Interactions API
  version: '1'
  summary: 'Control plane for Brix digital signage: screens, content, playlists, schedules, casts and emergencies.'
  description: 'Generated from the route table the API actually mounts

    (`apps/api/routes.snapshot.json`), the description each route is required to

    carry (`tests/contracts/route-registry.json`), and request/response schemas

    (`apps/api/src/openapi/`). CI enforces all three, so this document cannot list a

    route that does not exist or omit one that does.


    **Schemas.** 447 operations carry request and response schemas

    (`x-brix-schema: verified`). Each is checked in CI against the response the

    real handler returns — a missing, mistyped or undeclared field fails the build.

    The remaining operations are route-level only (`x-brix-schema: none`): their

    path, method, permission and purpose are exact, but the shape of `data` is not

    yet modelled, and we would rather say so than publish a schema that validates

    against nothing. Objects are open: a new field is not a breaking change.


    **Envelope.** Success bodies are `{ "data": … }`. Failures are

    `{ "error": "", "message": "…" }`, plus `requestId` on a 5xx.

    Many list routes page opt-in (see each operation): pass `?limit=` and

    follow `nextCursor` via `?cursor=` until it is null.


    **Authentication.** `Authorization: Bearer ` with an API key

    (`ak_…`, created in the console under Settings → API & MCP) or a user session. An

    API key carries a creator-chosen set of `resource.verb` permissions and may be

    pinned to one location''s subtree; a key can never be granted a permission its

    creator does not hold. The permission an operation needs is in

    `x-brix-permission` and in its security requirement.


    **Tenancy.** Every request resolves to one workspace. A resource belonging to

    another tenant returns 404, never 403, so a response never confirms that an

    account exists.


    **Rate limits.** A 429 carries `Retry-After`; a 503 `database_busy` means retry

    after the `Retry-After` interval.'
servers:
- url: https://api.brixsignage.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Interactions
paths:
  /v1/interactions:
    get:
      operationId: listInteractions
      tags:
      - Interactions
      summary: List interaction events
      description: '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.'
      x-brix-permission: playback-log.view
      x-brix-schema: verified
      x-brix-notes:
      - Newest first, at most 1000, from screens at locations the caller can see.
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: 'ISO-8601 start (default: 7 days ago).'
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: 'ISO-8601 end (default: now).'
      - name: screenId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        screenId:
                          type: string
                        screenName:
                          type: string
                          description: The screen id when the screen no longer exists.
                        at:
                          type: string
                          description: ISO-8601 timestamp (UTC).
                        kind:
                          type: string
                          enum:
                          - touch
                          - qr-scan
                          - screenshare-join
                          - form-submit
                        detail:
                          type: string
                          description: A short human-readable summary.
                        boxId:
                          description: 'A counted button tap only: the box that was tapped.'
                          anyOf:
                          - type: string
                          - type: 'null'
                        creativeId:
                          description: 'A counted button tap only: the design the box is on.'
                          anyOf:
                          - type: string
                          - type: 'null'
                        action:
                          description: 'A counted button tap only: the tap action kind (for example `open-url`).'
                          anyOf:
                          - type: string
                          - type: 'null'
                      required:
                      - id
                      - screenId
                      - screenName
                      - at
                      - kind
                      - detail
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - playback-log.view
  /v1/interactions/taps:
    get:
      operationId: listTapCounts
      tags:
      - Interactions
      summary: Count taps per button
      description: 'Returns the number of taps on each button of a design in a date range, with the design and box names. Only tap actions saved with `count: true` are counted. The busiest buttons come first, and at most 20,000 taps are read, from screens at the locations you can see.


        Counted taps per button (a box on a design) in the window. Only tap actions saved with `count: true` are counted.


        **Notes.**

        - Most taps first. Reads at most 20,000 taps, from screens at locations the caller can see.'
      x-brix-permission: playback-log.view
      x-brix-schema: verified
      x-brix-notes:
      - Most taps first. Reads at most 20,000 taps, from screens at locations the caller can see.
      parameters:
      - name: from
        in: query
        required: false
        schema:
          type: string
        description: 'ISO-8601 start (default: 7 days ago).'
      - name: to
        in: query
        required: false
        schema:
          type: string
        description: 'ISO-8601 end (default: now).'
      - name: screenId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        creativeId:
                          anyOf:
                          - type: string
                          - type: 'null'
                        creativeName:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: Null when the design is gone.
                        boxId:
                          type: string
                        boxName:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: The layer name, else its text. Null when the box is gone.
                        action:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: The tap action kind of the newest tap.
                        count:
                          type: integer
                        lastAt:
                          type: string
                          description: ISO-8601 timestamp (UTC).
                      required:
                      - creativeId
                      - creativeName
                      - boxId
                      - boxName
                      - action
                      - count
                      - lastAt
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - playback-log.view
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …'
        message:
          description: Human-readable explanation. Safe to show an operator.
          type: string
        requestId:
          description: 'Present on 5xx: quote it to support.'
          type: string
      required:
      - error
      additionalProperties: {}
      description: Error envelope returned by every failing request.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.