pub.chive.metrics.recordView Documentation (EN)

main procedure

Record a view event for an eprint

Input

Encodingapplication/json

uri stringat-uri Required

AT-URI of the eprint being viewed

viewerDid stringdid Optional

DID of the viewer (optional for anonymous views)

Output

Encodingapplication/json

success boolean Required

Whether the view was recorded

Errors

InvalidRequest

NotFound

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": [
        "uri"
      ],
      "properties": {
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the eprint being viewed"
        },
        "viewerDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the viewer (optional for anonymous views)"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidRequest"
    },
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "success"
      ],
      "properties": {
        "success": {
          "type": "boolean",
          "description": "Whether the view was recorded"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Record a view event for an eprint"
}