pub.chive.admin.getMetricsOverview

{
  "id": "pub.chive.admin.getMetricsOverview",
  "defs": {
    "main": {
      "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": {
      "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": {
      "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"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}