Data Quality

List records missing a field

The ids lacking a given field, paginated. This is the half a machine consumes: ask which manufacturers have no website, get the ids back, hand them to whatever fills them in.

A field the entity does not track is a 400 naming the ones it does. It is deliberately not an empty page: nothing missing reads as a clean bill of health, and a caller who mistyped a column name would believe it.

Requires Enterprise tier or higher.

get/v1/data/gaps/records

Request

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

Query parameters

entity'manufacturers' | 'firearms' | 'calibers' | 'attachments' | 'ammunition' required

Which catalog to report on

fieldstring required

The field the records are missing. Which fields are valid depends on entity, since each catalog tracks different columns: a field the named entity does not track is refused with 400 and the error lists the ones it does.

pageinteger

Page number, from 1 to 10,000

per_pageinteger

Items per page (max 100)

Response

List records missing a field

successboolean required

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

Example response

{
  "success": true,
  "data": [
    {
      "id": "accu-tek",
      "name": "Accu-Tek",
      "field": "website",
      "sources": [
        "https://www.accu-tekfirearms.com/"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "limit": 20,
    "total": 42,
    "totalPages": 3
  }
}

Changes

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