pub.chive.metrics.recordSearchDownload Documentation (EN)

main procedure

Record a download event from a search result (strong positive relevance signal)

Input

Encodingapplication/json

impressionId string Required

UUID of the search impression

uri stringat-uri Required

AT-URI of the downloaded eprint

Output

Encodingapplication/json

success boolean Required

Whether the download 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"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the downloaded eprint"
        },
        "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 download was recorded"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Record a download event from a search result (strong positive relevance signal)"
}