pub.chive.metrics.recordSearchClick Documentation (EN)

main procedure

Record a click event on a search result for LTR training data

Input

Encodingapplication/json

impressionId string Required

UUID of the search impression

position integer Required

Position of the result in the search results list

minimum: 0

uri stringat-uri Required

AT-URI of the clicked eprint

Output

Encodingapplication/json

success boolean Required

Whether the click was recorded

Errors

InvalidRequest

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "impressionId",
        "uri",
        "position"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the clicked eprint"
        },
        "position": {
          "type": "integer",
          "minimum": 0,
          "description": "Position of the result in the search results list"
        },
        "impressionId": {
          "type": "string",
          "description": "UUID of the search impression"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "success"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "description": "Whether the click was recorded"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Record a click event on a search result for LTR training data"
}