at.happyproto.fleet.getCapacity

happyproto.at

Documentation

Store capacity: the latest totals, a daily trend, per-collection counts and what each tenant holds. Proxied from the provisioner. Admin only.

main query

Store capacity: the latest totals, a daily trend, per-collection counts and what each tenant holds. Proxied from the provisioner. Admin only.

Parameters

from string datetime Optional

Start of the range. Defaults to 30 days before `to`.

to string datetime Optional

End of the range. Defaults to now.

Output

Encodingapplication/json
collections array Required

No description available.

latest ref#totals Optional

No description available.

tenants array Required

No description available.

trend array Required

No description available.

Errors

AuthRequired This endpoint requires an authenticated caller.
Forbidden The caller is not HappyProto staff, or the provisioner does not treat them as staff.
InvalidRequest The provisioner refused the range or grain, for example a range that runs backwards or is too long.
NotFound Passed through from the provisioner.
InvalidSlug Passed through from the provisioner.
SlugTaken Passed through from the provisioner.
NotEntitled Passed through from the provisioner.
InstanceLimit Passed through from the provisioner.
NoCapacity Passed through from the provisioner.
OperationInProgress Passed through from the provisioner.
Upstream The provisioner could not complete the request.
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
Start of the range. Defaults to 30 days before `to`.
End of the range. Defaults to now.
View raw schema 
{
  "description": "Store capacity: the latest totals, a daily trend, per-collection counts and what each tenant holds. Proxied from the provisioner. Admin only.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller is not HappyProto staff, or the provisioner does not treat them as staff.",
      "name": "Forbidden"
    },
    {
      "description": "The provisioner refused the range or grain, for example a range that runs backwards or is too long.",
      "name": "InvalidRequest"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NotFound"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "InvalidSlug"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "SlugTaken"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NotEntitled"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "InstanceLimit"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NoCapacity"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "OperationInProgress"
    },
    {
      "description": "The provisioner could not complete the request.",
      "name": "Upstream"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "collections": {
          "items": {
            "ref": "#collection",
            "type": "ref"
          },
          "type": "array"
        },
        "latest": {
          "ref": "#totals",
          "type": "ref"
        },
        "tenants": {
          "items": {
            "ref": "#tenant",
            "type": "ref"
          },
          "type": "array"
        },
        "trend": {
          "items": {
            "ref": "#trendPoint",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "trend",
        "collections",
        "tenants"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "from": {
        "description": "Start of the range. Defaults to 30 days before `to`.",
        "format": "datetime",
        "type": "string"
      },
      "to": {
        "description": "End of the range. Defaults to now.",
        "format": "datetime",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}
collection object

No description available.

Properties

configured boolean Optional

No description available.

crawl string Optional

No description available.

nsid string Required

No description available.

records integer Optional

No description available.

subscribers integer Optional

No description available.

View raw schema 
{
  "properties": {
    "configured": {
      "type": "boolean"
    },
    "crawl": {
      "type": "string"
    },
    "nsid": {
      "type": "string"
    },
    "records": {
      "type": "integer"
    },
    "subscribers": {
      "type": "integer"
    }
  },
  "required": [
    "nsid"
  ],
  "type": "object"
}
tenant object

No description available.

Properties

apiClients integer Optional

No description available.

collectionCount integer Optional

No description available.

diskBytes integer Optional

No description available.

gaps7d integer Optional

Hours with no usage report in the last 7 days.

id string Required

No description available.

plan string Optional

No description available.

recordsVisible integer Optional

No description available.

seats integer Optional

No description available.

slug string Required

No description available.

View raw schema 
{
  "properties": {
    "apiClients": {
      "type": "integer"
    },
    "collectionCount": {
      "type": "integer"
    },
    "diskBytes": {
      "type": "integer"
    },
    "gaps7d": {
      "description": "Hours with no usage report in the last 7 days.",
      "type": "integer"
    },
    "id": {
      "type": "string"
    },
    "lastHour": {
      "ref": "#tenantLastHour",
      "type": "ref"
    },
    "plan": {
      "type": "string"
    },
    "recordsVisible": {
      "type": "integer"
    },
    "seats": {
      "type": "integer"
    },
    "slug": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "slug"
  ],
  "type": "object"
}
tenantLastHour object

No description available.

Properties

cpuUsec integer Optional

CPU time used in the hour, in microseconds.

egressBytes integer Optional

No description available.

hour string datetime Required

An RFC 3339 formatted timestamp.

memAvgBytes integer Optional

No description available.

View raw schema 
{
  "properties": {
    "cpuUsec": {
      "description": "CPU time used in the hour, in microseconds.",
      "type": "integer"
    },
    "egressBytes": {
      "type": "integer"
    },
    "hour": {
      "format": "datetime",
      "type": "string"
    },
    "memAvgBytes": {
      "type": "integer"
    }
  },
  "required": [
    "hour"
  ],
  "type": "object"
}
totals object

The newest hourly snapshot of the shared store. Absent before the first one.

Properties

databaseBytes integer Optional

No description available.

diskCapacityBytes integer Optional

No description available.

diskFreeBytes integer Optional

No description available.

feedBytes integer Optional

No description available.

hour string datetime Required

An RFC 3339 formatted timestamp.

overlayBytes integer Optional

No description available.

records integer Optional

No description available.

recordsBytes integer Optional

No description available.

recordsIndexBytes integer Optional

No description available.

View raw schema 
{
  "description": "The newest hourly snapshot of the shared store. Absent before the first one.",
  "properties": {
    "databaseBytes": {
      "type": "integer"
    },
    "diskCapacityBytes": {
      "type": "integer"
    },
    "diskFreeBytes": {
      "type": "integer"
    },
    "feedBytes": {
      "type": "integer"
    },
    "hour": {
      "format": "datetime",
      "type": "string"
    },
    "overlayBytes": {
      "type": "integer"
    },
    "records": {
      "type": "integer"
    },
    "recordsBytes": {
      "type": "integer"
    },
    "recordsIndexBytes": {
      "type": "integer"
    }
  },
  "required": [
    "hour"
  ],
  "type": "object"
}
trendPoint object

No description available.

Properties

databaseBytes integer Optional

No description available.

day string Required

UTC date, YYYY-MM-DD.

records integer Optional

No description available.

View raw schema 
{
  "properties": {
    "databaseBytes": {
      "type": "integer"
    },
    "day": {
      "description": "UTC date, YYYY-MM-DD.",
      "type": "string"
    },
    "records": {
      "type": "integer"
    }
  },
  "required": [
    "day"
  ],
  "type": "object"
}

Lexicon Garden

@