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": {}
}
'

import requests

url = "https://api.mixpeek.com/v1/public/apps/{slug}/interactions"

payload = {
    "event_type": "<string>",
    "document_id": "<string>",
    "position": 123,
    "query": "<string>",
    "result_count": 123,
    "latency_ms": 123,
    "dwell_ms": 123,
    "session_id": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_type: '<string>',
    document_id: '<string>',
    position: 123,
    query: '<string>',
    result_count: 123,
    latency_ms: 123,
    dwell_ms: 123,
    session_id: '<string>',
    metadata: {}
  })
};

fetch('https://api.mixpeek.com/v1/public/apps/{slug}/interactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/public/apps/{slug}/interactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event_type' => '<string>',
    'document_id' => '<string>',
    'position' => 123,
    'query' => '<string>',
    'result_count' => 123,
    'latency_ms' => 123,
    'dwell_ms' => 123,
    'session_id' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/public/apps/{slug}/interactions"

	payload := strings.NewReader("{\n  \"event_type\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"position\": 123,\n  \"query\": \"<string>\",\n  \"result_count\": 123,\n  \"latency_ms\": 123,\n  \"dwell_ms\": 123,\n  \"session_id\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/public/apps/{slug}/interactions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_type\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"position\": 123,\n  \"query\": \"<string>\",\n  \"result_count\": 123,\n  \"latency_ms\": 123,\n  \"dwell_ms\": 123,\n  \"session_id\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/public/apps/{slug}/interactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_type\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"position\": 123,\n  \"query\": \"<string>\",\n  \"result_count\": 123,\n  \"latency_ms\": 123,\n  \"dwell_ms\": 123,\n  \"session_id\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

Public

Track an App interaction event

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

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": {}
}
'

import requests

url = "https://api.mixpeek.com/v1/public/apps/{slug}/interactions"

payload = {
    "event_type": "<string>",
    "document_id": "<string>",
    "position": 123,
    "query": "<string>",
    "result_count": 123,
    "latency_ms": 123,
    "dwell_ms": 123,
    "session_id": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_type: '<string>',
    document_id: '<string>',
    position: 123,
    query: '<string>',
    result_count: 123,
    latency_ms: 123,
    dwell_ms: 123,
    session_id: '<string>',
    metadata: {}
  })
};

fetch('https://api.mixpeek.com/v1/public/apps/{slug}/interactions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixpeek.com/v1/public/apps/{slug}/interactions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'event_type' => '<string>',
    'document_id' => '<string>',
    'position' => 123,
    'query' => '<string>',
    'result_count' => 123,
    'latency_ms' => 123,
    'dwell_ms' => 123,
    'session_id' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixpeek.com/v1/public/apps/{slug}/interactions"

	payload := strings.NewReader("{\n  \"event_type\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"position\": 123,\n  \"query\": \"<string>\",\n  \"result_count\": 123,\n  \"latency_ms\": 123,\n  \"dwell_ms\": 123,\n  \"session_id\": \"<string>\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/public/apps/{slug}/interactions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_type\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"position\": 123,\n  \"query\": \"<string>\",\n  \"result_count\": 123,\n  \"latency_ms\": 123,\n  \"dwell_ms\": 123,\n  \"session_id\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mixpeek.com/v1/public/apps/{slug}/interactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_type\": \"<string>\",\n  \"document_id\": \"<string>\",\n  \"position\": 123,\n  \"query\": \"<string>\",\n  \"result_count\": 123,\n  \"latency_ms\": 123,\n  \"dwell_ms\": 123,\n  \"session_id\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "details": {}
  },
  "success": false
}

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 | null

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.

Get taxonomy node tree for an App Create Session

Organization

Namespaces

Buckets

Feature Extractors

Batch Queue

Collections

Documents

Retrievers

Taxonomies

Clusters

Triggers

Alerts

Webhooks

Apps

Agent Sessions

Annotations

Templates

Manifest

Discovery

Analytics

Notifications

Tasks

Inference

Resource Search

Pricing

Track an App interaction event

Authorizations

Path Parameters

Body

Response