CyberRXN Docs
APIAPI reference

Corpus size and coverage

GET /v1/stats

GET /v1/stats

API overview · OpenAPI

Authorization

This operation requires a bearer credential. The description defines additional role, scope or first-party-session restrictions; an API key does not grant those permissions by itself.

Request body

No request body.

Responses

HTTPDetailsType
200Successful Responseapplication/json: Stats
401Unauthorizedapplication/problem+json: ProblemDetails
402Payment Requiredapplication/problem+json: ProblemDetails
403Forbiddenapplication/problem+json: ProblemDetails
408Request Timeoutapplication/problem+json: ProblemDetails
413Request Entity Too Largeapplication/problem+json: ProblemDetails
422Unprocessable Entityapplication/problem+json: ProblemDetails
429Too Many Requestsapplication/problem+json: ProblemDetails
502Bad Gatewayapplication/problem+json: ProblemDetails
503Service Unavailableapplication/problem+json: ProblemDetails

Response: Stats

PropertyTypeRequiredDetails
dataset_revisionstring ∣ nullno
observationsintegeryes
reactionsintegeryes
quarantinedintegeryes
upstream_validintegeryes
with_temperatureintegeryes
with_pressureintegeryes
with_agentsintegeryes
with_all_threeintegeryes
schema_versionintegeryes
unitsobjectyes
expert_confirmedintegeryes
similarity_is_predictionbooleanyes
ingest_statesobjectyes
data_completeboolean ∣ nullyes
Full schema
{
  "properties": {
    "dataset_revision": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dataset Revision"
    },
    "observations": {
      "type": "integer",
      "title": "Observations"
    },
    "reactions": {
      "type": "integer",
      "title": "Reactions"
    },
    "quarantined": {
      "type": "integer",
      "title": "Quarantined"
    },
    "upstream_valid": {
      "type": "integer",
      "title": "Upstream Valid"
    },
    "with_temperature": {
      "type": "integer",
      "title": "With Temperature"
    },
    "with_pressure": {
      "type": "integer",
      "title": "With Pressure"
    },
    "with_agents": {
      "type": "integer",
      "title": "With Agents"
    },
    "with_all_three": {
      "type": "integer",
      "title": "With All Three"
    },
    "schema_version": {
      "type": "integer",
      "title": "Schema Version"
    },
    "units": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Units"
    },
    "expert_confirmed": {
      "type": "integer",
      "title": "Expert Confirmed"
    },
    "similarity_is_prediction": {
      "type": "boolean",
      "title": "Similarity Is Prediction"
    },
    "ingest_states": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Ingest States"
    },
    "data_complete": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Data Complete"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "observations",
    "reactions",
    "quarantined",
    "upstream_valid",
    "with_temperature",
    "with_pressure",
    "with_agents",
    "with_all_three",
    "schema_version",
    "units",
    "expert_confirmed",
    "similarity_is_prediction",
    "ingest_states",
    "data_complete"
  ],
  "title": "Stats"
}

This page is generated from OpenAPI; examples are schemas, not a fabricated successful response.

Usage and billing · Structured errors

On this page