pub.chive.admin.getMetricsOverview

chive.pub

Documentation

Get metrics overview with trending eprints for a given period

main query

Get metrics overview with trending eprints for a given period

Parameters

days integer Optional

Number of days to aggregate

Output

Encodingapplication/json
trending array Optional

Trending eprints in the period

Errors

AuthenticationRequired
AdminRequired
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
Number of days to aggregate
View raw schema 
{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "AdminRequired"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "properties": {
        "period": {
          "ref": "#periodInfo",
          "type": "ref",
          "description": "Period information"
        },
        "trending": {
          "type": "array",
          "items": {
            "ref": "#trendingEprint",
            "type": "ref"
          },
          "description": "Trending eprints in the period"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "days": {
        "type": "integer",
        "default": 7,
        "maximum": 90,
        "minimum": 1,
        "description": "Number of days to aggregate"
      }
    }
  },
  "description": "Get metrics overview with trending eprints for a given period"
}
periodInfo object

Time period information

Properties

days integer Required

Number of days in the period

endDate string datetime Required

Period end date

startDate string datetime Required

Period start date

View raw schema 
{
  "type": "object",
  "required": [
    "days",
    "startDate",
    "endDate"
  ],
  "properties": {
    "days": {
      "type": "integer",
      "description": "Number of days in the period"
    },
    "endDate": {
      "type": "string",
      "format": "datetime",
      "description": "Period end date"
    },
    "startDate": {
      "type": "string",
      "format": "datetime",
      "description": "Period start date"
    }
  },
  "description": "Time period information"
}
trendingEprint object

A trending eprint with engagement metrics

Properties

authorDid string did Optional

Author DID

authorHandle string Optional

Author handle

downloads integer Required

Total downloads in period

title string Required

Eprint title

uri string at-uri Required

Eprint AT URI

velocity integer Optional

Engagement velocity in milliunits

views integer Required

Total views in period

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "title",
    "views",
    "downloads"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "Eprint AT URI"
    },
    "title": {
      "type": "string",
      "description": "Eprint title"
    },
    "views": {
      "type": "integer",
      "description": "Total views in period"
    },
    "velocity": {
      "type": "integer",
      "description": "Engagement velocity in milliunits"
    },
    "authorDid": {
      "type": "string",
      "format": "did",
      "description": "Author DID"
    },
    "downloads": {
      "type": "integer",
      "description": "Total downloads in period"
    },
    "authorHandle": {
      "type": "string",
      "description": "Author handle"
    }
  },
  "description": "A trending eprint with engagement metrics"
}

Lexicon Garden

@