Lexicon Garden

pub.chive.metrics.recordSearchDownload

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

Repository @lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh not from the namespace authority
Details · procedure
Kindprocedure
Authoritymetrics.chive.pub
Indexed
Compare Edit in builder → Fork →
cid bafyreicbioz44eilzojswynftjkxvvz53gnn5m6paoa3k5ictsm2yjte3e

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.impressionIdNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Record a download event from a search result (strong positive relevance signal)",
      "errors": [
        {
          "name": "InvalidRequest"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "impressionId": {
              "description": "UUID of the search impression",
              "type": "string"
            },
            "uri": {
              "description": "AT-URI of the downloaded eprint",
              "format": "at-uri",
              "type": "string"
            }
          },
          "required": [
            "impressionId",
            "uri"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "success": {
              "description": "Whether the download was recorded",
              "type": "boolean"
            }
          },
          "required": [
            "success"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "pub.chive.metrics.recordSearchDownload",
  "lexicon": 1,
  "revision": 1
}