Understanding the API Results

For search queries (such as: https://api.fda.gov/device/enforcement.json?search=classification:"Class+III"), the results section includes matching Device Enforcement reports returned by the API.

Each enforcement report consists of two major sections:

  • Enforcement report data: General information about the enforcement report.
  • An openfda section: An annotation with additional product identifiers, such as UPC and brand name, of the drug products listed in the enforcement report, if available.

The data format of RES enforcement reports changed in June 2012. In openFDA API results, reports from before that time do not contain the following fields:

  • event_id
  • status
  • city
  • state
  • country
  • voluntary_mandated
  • initial_firm_notification
  • recall_initiation_date

For count queries (such as: https://api.fda.gov/device/enforcement.json?count=voluntary_mandated.exact), the results section will look something like the following: