at.happyproto.fleet.getLexiconShape Documentation (EN)

main query

Lexicon counts and top-collection concentration. Reads tier-1 shape only; consent-gated lexicon names are not read here. Admin only.

Output

Encodingapplication/json

coverage ref#coverage Optional

No description available.

have integer Optional

History available, when accruing.

instances integer Optional

No description available.

lexiconCount ref#pair Optional

No description available.

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

topCollectionShare ref#pair Optional

No description available.

unit string Optional

No description available.

Known values: days, snapshots

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.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

View raw schema

{
  "description": "Lexicon counts and top-collection concentration. Reads tier-1 shape only; consent-gated lexicon names are not read here. 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"
        },
        "have": {
          "description": "History available, when accruing.",
          "type": "integer"
        },
        "instances": {
          "type": "integer"
        },
        "lexiconCount": {
          "ref": "#pair",
          "type": "ref"
        },
        "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"
        },
        "topCollectionShare": {
          "ref": "#pair",
          "type": "ref"
        },
        "unit": {
          "knownValues": [
            "days",
            "snapshots"
          ],
          "type": "string"
        }
      },
      "required": [
        "status"
      ],
      "type": "object"
    }
  },
  "type": "query"
}

coverage object

No description available.

Properties

of integer Required

No description available.

sharing integer Required

No description available.

View raw schema

{
  "properties": {
    "of": {
      "type": "integer"
    },
    "sharing": {
      "type": "integer"
    }
  },
  "required": [
    "sharing",
    "of"
  ],
  "type": "object"
}

pair object

No description available.

Properties

p50 integer Required

No description available.

p90 integer Required

No description available.

View raw schema

{
  "properties": {
    "p50": {
      "type": "integer"
    },
    "p90": {
      "type": "integer"
    }
  },
  "required": [
    "p50",
    "p90"
  ],
  "type": "object"
}