Data Quality

Get dataset field coverage

Returns per-field completeness across the catalog, so you can tell which specifications are reliably populated before depending on them.

Requires Enterprise tier or higher.

get/v1/data/coverage

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/data/coverage
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

Get dataset field coverage

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "firearms": {
      "total": 8629,
      "fields": {
        "year_introduced": {
          "filled": 8140,
          "percentage": 88.8
        }
      }
    },
    "calibers": {
      "total": 8629,
      "fields": {
        "year_introduced": {
          "filled": 8140,
          "percentage": 88.8
        }
      }
    },
    "manufacturers": {
      "total": 8629,
      "fields": {
        "year_introduced": {
          "filled": 8140,
          "percentage": 88.8
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.