Skip to main content
POST
/
v1
/
public
/
apps
/
{slug}
/
interactions
Track an App interaction event
curl --request POST \
  --url https://api.mixpeek.com/v1/public/apps/{slug}/interactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "<string>",
  "document_id": "<string>",
  "position": 123,
  "query": "<string>",
  "result_count": 123,
  "latency_ms": 123,
  "dwell_ms": 123,
  "session_id": "<string>",
  "metadata": {}
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
slug
string
required

Globally unique app slug

Body

application/json

Request body for tracking a user interaction with a public App.

Extra top-level fields are stored as-is alongside the standard fields, allowing callers to attach arbitrary metadata without schema changes.

​
event_type
string
required

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

​
document_id
string | null

ID of the document interacted with

​
position
integer | null

Zero-based position of the result

​
query
string | null

Search query that produced the result

​
result_count
integer | null

Number of results returned

​
latency_ms
integer | null

Time from request to first result (ms)

​
dwell_ms
integer | null

Time the user spent on the result (ms)

​
session_id
string | null

Client-side session identifier

​
metadata
Metadata · object

Arbitrary extra metadata

Response

Acknowledgement that the event was recorded

The response is of type Response Track Public App Interaction V1 Public Apps Slug Interactions Post · object.