at.happyproto.fleet.getIngestHealth

happyproto.at

Documentation

Report lag, clock skew and schema-version spread. Lag and skew are separate facts and must not be averaged together. Admin only.

main query

Report lag, clock skew and schema-version spread. Lag and skew are separate facts and must not be averaged together. Admin only.

Output

Encodingapplication/json
have integer Optional

History available, when accruing.

lag ref#lag Optional

No description available.

need integer Optional

History required, when accruing.

schemaVersions array Optional

No description available.

skewed array Optional

No description available.

status string Required

Why a figure is absent. Branch on this, never on field presence.

Known values: ok, accruing, withheld
unit string Optional

No description available.

Known values: days, snapshots
windowDays integer Optional

No description available.

Errors

AuthRequired This endpoint requires an authenticated caller.
Forbidden The caller is not a HappyProto admin.
Upstream The telemetry store could not be queried.
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)
View raw schema
{
  "description": "Report lag, clock skew and schema-version spread. Lag and skew are separate facts and must not be averaged together. Admin only.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller is not a HappyProto admin.",
      "name": "Forbidden"
    },
    {
      "description": "The telemetry store could not be queried.",
      "name": "Upstream"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "have": {
          "description": "History available, when accruing.",
          "type": "integer"
        },
        "lag": {
          "ref": "#lag",
          "type": "ref"
        },
        "need": {
          "description": "History required, when accruing.",
          "type": "integer"
        },
        "schemaVersions": {
          "items": {
            "ref": "#schemaVersion",
            "type": "ref"
          },
          "type": "array"
        },
        "skewed": {
          "items": {
            "ref": "#skew",
            "type": "ref"
          },
          "type": "array"
        },
        "status": {
          "description": "Why a figure is absent. Branch on this, never on field presence.",
          "knownValues": [
            "ok",
            "accruing",
            "withheld"
          ],
          "type": "string"
        },
        "unit": {
          "knownValues": [
            "days",
            "snapshots"
          ],
          "type": "string"
        },
        "windowDays": {
          "type": "integer"
        }
      },
      "required": [
        "status"
      ],
      "type": "object"
    }
  },
  "type": "query"
}
lag object

No description available.

Properties

max integer Required

No description available.

p50 integer Required

No description available.

p90 integer Required

No description available.

View raw schema
{
  "properties": {
    "max": {
      "type": "integer"
    },
    "p50": {
      "type": "integer"
    },
    "p90": {
      "type": "integer"
    }
  },
  "required": [
    "p50",
    "p90",
    "max"
  ],
  "type": "object"
}
schemaVersion object

No description available.

Properties

instances integer Required

No description available.

version integer Required

No description available.

View raw schema
{
  "properties": {
    "instances": {
      "type": "integer"
    },
    "version": {
      "type": "integer"
    }
  },
  "required": [
    "version",
    "instances"
  ],
  "type": "object"
}
skew object

No description available.

Properties

aheadSeconds integer Required

Seconds the snapshot was stamped ahead of receipt. A wrong clock makes every delta from this instance suspect.

instanceId string Required

No description available.

View raw schema
{
  "properties": {
    "aheadSeconds": {
      "description": "Seconds the snapshot was stamped ahead of receipt. A wrong clock makes every delta from this instance suspect.",
      "type": "integer"
    },
    "instanceId": {
      "type": "string"
    }
  },
  "required": [
    "instanceId",
    "aheadSeconds"
  ],
  "type": "object"
}

Lexicon Garden

@