Public Apps API

Track an App interaction event

Changed on

Record a user interaction event for a public App — no authentication required.

Interaction events are written to the app_interactions collection for analytics and relevance tuning. Write errors are swallowed server-side so that a transient storage failure never surfaces as an error to the caller.

Example:

{
  "event_type": "click",
  "document_id": "doc_abc123",
  "position": 2,
  "query": "red sneakers",
  "session_id": "sess_xyz"
}
post/v1/public/apps/{slug}/interactions

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/public/apps/{slug}/interactions
  • Auth: none required

Path parameters

slugstring required

Globally unique app slug

Request body

event_typestring required

Interaction event type (e.g. 'click', 'search')

document_idstring nullable

ID of the document interacted with

positioninteger nullable

Zero-based position of the result

querystring nullable

Search query that produced the result

result_countinteger nullable

Number of results returned

latency_msinteger nullable

Time from request to first result (ms)

dwell_msinteger nullable

Time the user spent on the result (ms)

session_idstring nullable

Client-side session identifier

metadataobject nullable

Arbitrary extra metadata

Response

Acknowledgement that the event was recorded

object required

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status