Athena
Schema

Inspect logging-schema expected-vs-observed diagnostics

Returns expected-vs-observed logging schema state, missing columns/tables, and an overall health summary.

GET
/debug/schema

Header Parameters

apikey*string

The static admin key configured as ATHENA_KEY_12. Authorization headers (Bearer <key>), X-API-Key, X-Athena-Key, or ?api_key= are also accepted.

Response Body

application/json

curl -X GET "https://athena-cluster.com/debug/schema" \  -H "apikey: string"
{
  "logging_client": "string",
  "generated_at": "2019-08-24T14:15:22Z",
  "summary": {
    "health": "string",
    "health_reasons": [
      {
        "code": "string",
        "severity": "string",
        "count": 0,
        "message": "string"
      }
    ],
    "expected_table_count": 0,
    "found_table_count": 0,
    "required_missing_table_count": 0,
    "optional_missing_table_count": 0,
    "required_missing_column_count": 0,
    "optional_missing_column_count": 0,
    "relation_type_mismatch_count": 0
  },
  "expected_tables": [
    {
      "table_schema": "string",
      "table_name": "string",
      "expected_relation_type": "string",
      "required": true,
      "purpose": "string",
      "expected_columns": [
        "string"
      ],
      "found": true,
      "found_relation_type": "string",
      "relation_type_matches": true,
      "found_columns": [
        "string"
      ],
      "missing_columns": [
        "string"
      ],
      "unexpected_columns": [
        "string"
      ]
    }
  ],
  "still_needed": {
    "required_missing_tables": [
      "string"
    ],
    "optional_missing_tables": [
      "string"
    ],
    "required_missing_columns": [
      "string"
    ],
    "optional_missing_columns": [
      "string"
    ],
    "relation_type_mismatches": [
      "string"
    ]
  },
  "observed_tables": [
    {
      "table_schema": "string",
      "table_name": "string",
      "relation_type": "string",
      "columns": [
        "string"
      ]
    }
  ],
  "missing_required_tables": [
    "string"
  ],
  "missing_optional_tables": [
    "string"
  ]
}
Empty
Empty
Empty