at.happyproto.fleet.getHostMix

happyproto.at

Documentation

Categorical host facts across the fleet, with consent coverage. Keys whose values vary per instance, or that carry embedded documents, are named but not enumerated. Admin only.

main query

Categorical host facts across the fleet, with consent coverage. Keys whose values vary per instance, or that carry embedded documents, are named but not enumerated. Admin only.

Output

Encodingapplication/json
coverage ref#coverage Required

No description available.

facts array Required

Only keys whose values repeat across instances. A value seen once per instance is a measurement, not a category.

have integer Optional

History available, when accruing.

need integer Optional

History required, when accruing.

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
varying array Required

Host keys that are not a mix: values differ per instance, or are JSON documents. Named so a reader knows the key exists, without rendering one row per instance.

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": "Categorical host facts across the fleet, with consent coverage. Keys whose values vary per instance, or that carry embedded documents, are named but not enumerated. 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": {
        "coverage": {
          "ref": "#coverage",
          "type": "ref"
        },
        "facts": {
          "description": "Only keys whose values repeat across instances. A value seen once per instance is a measurement, not a category.",
          "items": {
            "ref": "#fact",
            "type": "ref"
          },
          "type": "array"
        },
        "have": {
          "description": "History available, when accruing.",
          "type": "integer"
        },
        "need": {
          "description": "History required, when accruing.",
          "type": "integer"
        },
        "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"
        },
        "varying": {
          "description": "Host keys that are not a mix: values differ per instance, or are JSON documents. Named so a reader knows the key exists, without rendering one row per instance.",
          "items": {
            "ref": "#varyingKey",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "status",
        "coverage",
        "facts",
        "varying"
      ],
      "type": "object"
    }
  },
  "type": "query"
}
coverage object

No description available.

Properties

of integer Required

A count over twelve of thirty instances is a different claim from a count over thirty.

sharing integer Required

No description available.

View raw schema 
{
  "properties": {
    "of": {
      "description": "A count over twelve of thirty instances is a different claim from a count over thirty.",
      "type": "integer"
    },
    "sharing": {
      "type": "integer"
    }
  },
  "required": [
    "sharing",
    "of"
  ],
  "type": "object"
}
fact object

No description available.

Properties

instances integer Required

No description available.

key string Required

No description available.

value string Required

No description available.

View raw schema 
{
  "properties": {
    "instances": {
      "type": "integer"
    },
    "key": {
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "value",
    "instances"
  ],
  "type": "object"
}
varyingKey object

No description available.

Properties

distinctValues integer Required

No description available.

key string Required

No description available.

View raw schema 
{
  "properties": {
    "distinctValues": {
      "type": "integer"
    },
    "key": {
      "type": "string"
    }
  },
  "required": [
    "key",
    "distinctValues"
  ],
  "type": "object"
}

Lexicon Garden

@