ApiMetrics.apiUsageSnapshot — API

ApiMetrics.apiUsageSnapshotconstsrc/ApiUsageSchema.ts:45

Schema.Struct<{
  readonly clientId: Schema.String
  readonly inFlight: Schema.Number
  readonly requestsTotal: Schema.Number
  readonly errorsTotal: Schema.Number
  readonly topEndpoints: Schema.$Array<
    Schema.Struct<{
      readonly group: Schema.String
      readonly endpoint: Schema.String
      readonly requests: Schema.Number
      readonly errors: Schema.Number
    }>
  >
}>

Point-in-time API usage snapshot — element of the ApiMetrics usage ref (usage.get).

wire schemasApiMetrics

Source src/ApiUsageSchema.ts:4514 lines

export const apiUsageSnapshot = Schema.Type;

ProjectStruct({
  clientId: Schema.String,
  inFlight: Schema.Number,
  requestsTotal: Schema.Number,
  errorsTotal: Schema.Number,
  topEndpoints: Schema.Array(
    Schema.Struct({
      group: Schema.String,
      endpoint: Schema.String,
      requests: Schema.Number,
      errors: Schema.Number,
    }),
  ),
});