at.happyproto.fleet.getBenchmarks

{
  "description": "Where one instance sits in its size cohort. Withheld below a cohort of 10: a percentile over fewer is not an aggregate, it is individual data with a statistic drawn over it. 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"
    },
    {
      "description": "instance is required.",
      "name": "InvalidRequest"
    },
    {
      "description": "No snapshots for that instance.",
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cohort": {
          "type": "string"
        },
        "cohortSize": {
          "type": "integer"
        },
        "computedAt": {
          "description": "The rollup refreshes daily, so this can be 24 hours old.",
          "format": "datetime",
          "type": "string"
        },
        "have": {
          "description": "History available, when accruing.",
          "type": "integer"
        },
        "metrics": {
          "items": {
            "ref": "#metric",
            "type": "ref"
          },
          "type": "array"
        },
        "minimum": {
          "description": "Smallest cohort a benchmark is published for.",
          "type": "integer"
        },
        "need": {
          "description": "History required, when accruing.",
          "type": "integer"
        },
        "reason": {
          "knownValues": [
            "cohort"
          ],
          "type": "string"
        },
        "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"
        }
      },
      "required": [
        "status",
        "metrics"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "instance": {
        "description": "Instance id to position within its cohort.",
        "type": "string"
      }
    },
    "required": [
      "instance"
    ],
    "type": "params"
  },
  "type": "query"
}