pub.chive.metrics.getTrending

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "authorRef": {
      "description": "Reference to an author with optional ATProto identity",
      "properties": {
        "affiliations": {
          "items": {
            "ref": "pub.chive.defs#affiliation",
            "type": "ref"
          },
          "type": "array"
        },
        "avatarUrl": {
          "description": "Avatar URL (if available)",
          "type": "string"
        },
        "contributions": {
          "items": {
            "ref": "#contribution",
            "type": "ref"
          },
          "type": "array"
        },
        "did": {
          "description": "Author DID (if linked to ATProto identity)",
          "format": "did",
          "type": "string"
        },
        "email": {
          "description": "Contact email",
          "type": "string"
        },
        "handle": {
          "description": "ATProto handle (if resolved)",
          "type": "string"
        },
        "isCorrespondingAuthor": {
          "description": "Whether this is the corresponding author",
          "type": "boolean"
        },
        "isHighlighted": {
          "description": "Whether to highlight this author",
          "type": "boolean"
        },
        "name": {
          "description": "Display name",
          "type": "string"
        },
        "orcid": {
          "description": "ORCID identifier",
          "type": "string"
        },
        "order": {
          "description": "Author order position",
          "minimum": 1,
          "type": "integer"
        }
      },
      "required": [
        "name",
        "order",
        "affiliations",
        "contributions"
      ],
      "type": "object"
    },
    "contribution": {
      "description": "CRediT contribution role",
      "properties": {
        "degree": {
          "description": "Degree of contribution (lead, supporting, equal)",
          "type": "string"
        },
        "typeId": {
          "description": "Contribution type slug",
          "type": "string"
        },
        "typeLabel": {
          "description": "Human-readable contribution label",
          "type": "string"
        },
        "typeUri": {
          "description": "AT-URI of the contribution type node",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "typeUri",
        "typeId",
        "typeLabel"
      ],
      "type": "object"
    },
    "eprintMetrics": {
      "description": "Current metrics for the eprint",
      "properties": {
        "downloads": {
          "description": "Total download count",
          "minimum": 0,
          "type": "integer"
        },
        "endorsements": {
          "description": "Endorsement count",
          "minimum": 0,
          "type": "integer"
        },
        "views": {
          "description": "Total view count",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "views",
        "downloads"
      ],
      "type": "object"
    },
    "fieldRef": {
      "description": "Reference to a knowledge graph field node",
      "properties": {
        "id": {
          "description": "Field ID",
          "type": "string"
        },
        "label": {
          "description": "Display label",
          "type": "string"
        },
        "parentUri": {
          "description": "Parent field URI",
          "format": "at-uri",
          "type": "string"
        },
        "uri": {
          "description": "AT-URI of the field node",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "label"
      ],
      "type": "object"
    },
    "main": {
      "description": "Get trending eprints based on view counts within a time window",
      "errors": [],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "Cursor for next page",
              "type": "string"
            },
            "hasMore": {
              "description": "Whether more results are available",
              "type": "boolean"
            },
            "trending": {
              "items": {
                "ref": "#trendingEntry",
                "type": "ref"
              },
              "type": "array"
            },
            "window": {
              "description": "Time window used",
              "enum": [
                "24h",
                "7d",
                "30d"
              ],
              "type": "string"
            }
          },
          "required": [
            "trending",
            "window",
            "hasMore"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Pagination cursor",
            "type": "string"
          },
          "fieldUris": {
            "description": "Optional field URIs to flag matching eprints as in-field",
            "items": {
              "format": "at-uri",
              "type": "string"
            },
            "maxLength": 50,
            "type": "array"
          },
          "limit": {
            "default": 20,
            "description": "Maximum number of results to return",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "window": {
            "default": "7d",
            "description": "Time window for trending calculation",
            "enum": [
              "24h",
              "7d",
              "30d"
            ],
            "type": "string"
          }
        },
        "type": "params"
      },
      "type": "query"
    },
    "sourceInfo": {
      "description": "PDS source information for data transparency",
      "properties": {
        "blobUrl": {
          "description": "URL to fetch associated blob",
          "type": "string"
        },
        "lastVerifiedAt": {
          "description": "When the record was last verified",
          "format": "datetime",
          "type": "string"
        },
        "pdsEndpoint": {
          "description": "URL of the source PDS",
          "type": "string"
        },
        "recordUrl": {
          "description": "Direct URL to fetch the record",
          "type": "string"
        },
        "stale": {
          "description": "Whether the indexed data may be stale",
          "type": "boolean"
        }
      },
      "required": [
        "pdsEndpoint",
        "recordUrl",
        "lastVerifiedAt",
        "stale"
      ],
      "type": "object"
    },
    "trendingEntry": {
      "description": "A trending eprint entry with full metadata",
      "properties": {
        "abstract": {
          "description": "Rich abstract with text, formatting, and entity references",
          "items": {
            "refs": [
              "pub.chive.richtext.defs#textItem",
              "pub.chive.richtext.defs#nodeRefItem",
              "pub.chive.richtext.defs#wikidataRefItem",
              "pub.chive.richtext.defs#fieldRefItem",
              "pub.chive.richtext.defs#facetRefItem",
              "pub.chive.richtext.defs#eprintRefItem",
              "pub.chive.richtext.defs#annotationRefItem",
              "pub.chive.richtext.defs#authorRefItem",
              "pub.chive.richtext.defs#mentionItem",
              "pub.chive.richtext.defs#linkItem",
              "pub.chive.richtext.defs#tagItem",
              "pub.chive.richtext.defs#latexItem",
              "pub.chive.richtext.defs#codeBlockItem",
              "pub.chive.richtext.defs#headingItem",
              "pub.chive.richtext.defs#listItem",
              "pub.chive.richtext.defs#blockquoteItem"
            ],
            "type": "union"
          },
          "maxLength": 500,
          "type": "array"
        },
        "authors": {
          "items": {
            "ref": "#authorRef",
            "type": "ref"
          },
          "type": "array"
        },
        "cid": {
          "description": "CID of the eprint record",
          "format": "cid",
          "type": "string"
        },
        "createdAt": {
          "description": "Original creation timestamp",
          "format": "datetime",
          "type": "string"
        },
        "fields": {
          "description": "Knowledge graph field classifications",
          "items": {
            "ref": "#fieldRef",
            "type": "ref"
          },
          "type": "array"
        },
        "inUserFields": {
          "description": "Whether this eprint matches the requested fieldUris",
          "type": "boolean"
        },
        "indexedAt": {
          "description": "When Chive indexed this record",
          "format": "datetime",
          "type": "string"
        },
        "license": {
          "description": "License identifier",
          "type": "string"
        },
        "metrics": {
          "description": "Current metrics snapshot",
          "ref": "#eprintMetrics",
          "type": "ref"
        },
        "paperDid": {
          "description": "DID of the paper identity (if using paper-centric model)",
          "format": "did",
          "type": "string"
        },
        "rank": {
          "description": "Position in trending list",
          "minimum": 1,
          "type": "integer"
        },
        "source": {
          "description": "PDS source information for transparency",
          "ref": "#sourceInfo",
          "type": "ref"
        },
        "submittedBy": {
          "description": "DID of the submitter",
          "format": "did",
          "type": "string"
        },
        "title": {
          "description": "Eprint title",
          "type": "string"
        },
        "uri": {
          "description": "AT-URI of the eprint",
          "format": "at-uri",
          "type": "string"
        },
        "velocity": {
          "description": "Rate of view increase (optional)",
          "type": "integer"
        },
        "viewsInWindow": {
          "description": "Views within the trending window",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "uri",
        "cid",
        "title",
        "abstract",
        "authors",
        "submittedBy",
        "license",
        "createdAt",
        "indexedAt",
        "source",
        "viewsInWindow",
        "rank"
      ],
      "type": "object"
    }
  },
  "id": "pub.chive.metrics.getTrending",
  "lexicon": 1,
  "revision": 2
}