pub.chive.metrics.getTrending

chive.pub

Documentation

Get trending eprints based on view counts within a time window

main query

Get trending eprints based on view counts within a time window

Parameters

cursor string Optional

Pagination cursor

fieldUris array of string Optional

Optional field URIs to flag matching eprints as in-field

limit integer Optional

Maximum number of results to return

window string Optional

Time window for trending calculation

Output

Encodingapplication/json
cursor string Optional

Cursor for next page

hasMore boolean Required

Whether more results are available

trending array Required

No description available.

window string Required

Time window used

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Pagination cursor
Optional field URIs to flag matching eprints as in-field
Maximum number of results to return
Time window for trending calculation
View raw schema
{
  "type": "query",
  "errors": [],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "trending",
        "window",
        "hasMore"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "Cursor for next page"
        },
        "window": {
          "enum": [
            "24h",
            "7d",
            "30d"
          ],
          "type": "string",
          "description": "Time window used"
        },
        "hasMore": {
          "type": "boolean",
          "description": "Whether more results are available"
        },
        "trending": {
          "type": "array",
          "items": {
            "ref": "#trendingEntry",
            "type": "ref"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "limit": {
        "type": "integer",
        "default": 20,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of results to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor"
      },
      "window": {
        "enum": [
          "24h",
          "7d",
          "30d"
        ],
        "type": "string",
        "default": "7d",
        "description": "Time window for trending calculation"
      },
      "fieldUris": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "maxLength": 50,
        "description": "Optional field URIs to flag matching eprints as in-field"
      }
    }
  },
  "description": "Get trending eprints based on view counts within a time window"
}
authorRef object

Reference to an author with optional ATProto identity

Properties

avatarUrl string Optional

Avatar URL (if available)

contributions array of ref#contribution Required

No description available.

did string did Optional

Author DID (if linked to ATProto identity)

email string Optional

Contact email

handle string Optional

ATProto handle (if resolved)

isCorrespondingAuthor boolean Optional

Whether this is the corresponding author

isHighlighted boolean Optional

Whether to highlight this author

name string Required

Display name

orcid string Optional

ORCID identifier

order integer Required

Author order position

minimum: 1
View raw schema
{
  "type": "object",
  "required": [
    "name",
    "order",
    "affiliations",
    "contributions"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did",
      "description": "Author DID (if linked to ATProto identity)"
    },
    "name": {
      "type": "string",
      "description": "Display name"
    },
    "email": {
      "type": "string",
      "description": "Contact email"
    },
    "orcid": {
      "type": "string",
      "description": "ORCID identifier"
    },
    "order": {
      "type": "integer",
      "minimum": 1,
      "description": "Author order position"
    },
    "handle": {
      "type": "string",
      "description": "ATProto handle (if resolved)"
    },
    "avatarUrl": {
      "type": "string",
      "description": "Avatar URL (if available)"
    },
    "affiliations": {
      "type": "array",
      "items": {
        "ref": "pub.chive.defs#affiliation",
        "type": "ref"
      }
    },
    "contributions": {
      "type": "array",
      "items": {
        "ref": "#contribution",
        "type": "ref"
      }
    },
    "isHighlighted": {
      "type": "boolean",
      "description": "Whether to highlight this author"
    },
    "isCorrespondingAuthor": {
      "type": "boolean",
      "description": "Whether this is the corresponding author"
    }
  },
  "description": "Reference to an author with optional ATProto identity"
}
contribution object

CRediT contribution role

Properties

degree string Optional

Degree of contribution (lead, supporting, equal)

typeId string Required

Contribution type slug

typeLabel string Required

Human-readable contribution label

typeUri string at-uri Required

AT-URI of the contribution type node

View raw schema
{
  "type": "object",
  "required": [
    "typeUri",
    "typeId",
    "typeLabel"
  ],
  "properties": {
    "degree": {
      "type": "string",
      "description": "Degree of contribution (lead, supporting, equal)"
    },
    "typeId": {
      "type": "string",
      "description": "Contribution type slug"
    },
    "typeUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the contribution type node"
    },
    "typeLabel": {
      "type": "string",
      "description": "Human-readable contribution label"
    }
  },
  "description": "CRediT contribution role"
}
eprintMetrics object

Current metrics for the eprint

Properties

downloads integer Required

Total download count

minimum: 0
endorsements integer Optional

Endorsement count

minimum: 0
views integer Required

Total view count

minimum: 0
View raw schema
{
  "type": "object",
  "required": [
    "views",
    "downloads"
  ],
  "properties": {
    "views": {
      "type": "integer",
      "minimum": 0,
      "description": "Total view count"
    },
    "downloads": {
      "type": "integer",
      "minimum": 0,
      "description": "Total download count"
    },
    "endorsements": {
      "type": "integer",
      "minimum": 0,
      "description": "Endorsement count"
    }
  },
  "description": "Current metrics for the eprint"
}
fieldRef object

Reference to a knowledge graph field node

Properties

id string Optional

Field ID

label string Required

Display label

parentUri string at-uri Optional

Parent field URI

uri string at-uri Required

AT-URI of the field node

View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "label"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Field ID"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the field node"
    },
    "label": {
      "type": "string",
      "description": "Display label"
    },
    "parentUri": {
      "type": "string",
      "format": "at-uri",
      "description": "Parent field URI"
    }
  },
  "description": "Reference to a knowledge graph field node"
}
sourceInfo object

PDS source information for data transparency

Properties

blobUrl string Optional

URL to fetch associated blob

lastVerifiedAt string datetime Required

When the record was last verified

pdsEndpoint string Required

URL of the source PDS

recordUrl string Required

Direct URL to fetch the record

stale boolean Required

Whether the indexed data may be stale

View raw schema
{
  "type": "object",
  "required": [
    "pdsEndpoint",
    "recordUrl",
    "lastVerifiedAt",
    "stale"
  ],
  "properties": {
    "stale": {
      "type": "boolean",
      "description": "Whether the indexed data may be stale"
    },
    "blobUrl": {
      "type": "string",
      "description": "URL to fetch associated blob"
    },
    "recordUrl": {
      "type": "string",
      "description": "Direct URL to fetch the record"
    },
    "pdsEndpoint": {
      "type": "string",
      "description": "URL of the source PDS"
    },
    "lastVerifiedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the record was last verified"
    }
  },
  "description": "PDS source information for data transparency"
}
trendingEntry object

A trending eprint entry with full metadata

Properties

abstract array of union Required
authors array of ref#authorRef Required

No description available.

cid string cid Required

CID of the eprint record

createdAt string datetime Required

Original creation timestamp

fields array of ref#fieldRef Optional

Knowledge graph field classifications

inUserFields boolean Optional

Whether this eprint matches the requested fieldUris

indexedAt string datetime Required

When Chive indexed this record

license string Required

License identifier

paperDid string did Optional

DID of the paper identity (if using paper-centric model)

rank integer Required

Position in trending list

minimum: 1
source ref #sourceInfo Required

PDS source information for transparency

submittedBy string did Required

DID of the submitter

title string Required

Eprint title

uri string at-uri Required

AT-URI of the eprint

velocity integer Optional

Rate of view increase (optional)

viewsInWindow integer Required

Views within the trending window

minimum: 0
View raw schema
{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "title",
    "abstract",
    "authors",
    "submittedBy",
    "license",
    "createdAt",
    "indexedAt",
    "source",
    "viewsInWindow",
    "rank"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the eprint record"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the eprint"
    },
    "rank": {
      "type": "integer",
      "minimum": 1,
      "description": "Position in trending list"
    },
    "title": {
      "type": "string",
      "description": "Eprint title"
    },
    "fields": {
      "type": "array",
      "items": {
        "ref": "#fieldRef",
        "type": "ref"
      },
      "description": "Knowledge graph field classifications"
    },
    "source": {
      "ref": "#sourceInfo",
      "type": "ref",
      "description": "PDS source information for transparency"
    },
    "authors": {
      "type": "array",
      "items": {
        "ref": "#authorRef",
        "type": "ref"
      }
    },
    "license": {
      "type": "string",
      "description": "License identifier"
    },
    "metrics": {
      "ref": "#eprintMetrics",
      "type": "ref",
      "description": "Current metrics snapshot"
    },
    "abstract": {
      "type": "array",
      "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,
      "description": "Rich abstract with text, formatting, and entity references"
    },
    "paperDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the paper identity (if using paper-centric model)"
    },
    "velocity": {
      "type": "integer",
      "description": "Rate of view increase (optional)"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Original creation timestamp"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When Chive indexed this record"
    },
    "submittedBy": {
      "type": "string",
      "format": "did",
      "description": "DID of the submitter"
    },
    "inUserFields": {
      "type": "boolean",
      "description": "Whether this eprint matches the requested fieldUris"
    },
    "viewsInWindow": {
      "type": "integer",
      "minimum": 0,
      "description": "Views within the trending window"
    }
  },
  "description": "A trending eprint entry with full metadata"
}

Lexicon Garden

@