pub.chive.metrics.recordDwellTime Documentation (EN)

main procedure

Record dwell time for a clicked search result (called via beacon API)

Input

Encodingapplication/json

dwellTimeMs integer Required

Time spent on the page in milliseconds

minimum: 0

impressionId string Required

UUID of the search impression

uri stringat-uri Required

AT-URI of the viewed eprint

Output

Encodingapplication/json

success boolean Required

Whether the dwell time 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",
        "dwellTimeMs"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the viewed eprint"
        },
        "dwellTimeMs": {
          "type": "integer",
          "minimum": 0,
          "description": "Time spent on the page in milliseconds"
        },
        "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 dwell time was recorded"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Record dwell time for a clicked search result (called via beacon API)"
}