pub.chive.metrics.recordDownload Documentation (EN)

main procedure

Record a download event for an eprint

Input

Encodingapplication/json

uri stringat-uri Required

AT-URI of the eprint being downloaded

viewerDid stringdid Optional

DID of the downloader (optional for anonymous downloads)

Output

Encodingapplication/json

success boolean Required

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