API Documentation

Public API

The Project Harvest API gives the public the ability to pull and ingest all standards and sample data collected over the course of the 3-year project.

The API is broken down into the following concepts:

  1. Standards: the enforceable and regulatory values, developed either by federal agencies or by the state of Arizona for water providers/utilities.
  2. Samples: The samples include top-level contextual information like "lab inorganic water". This endpoint works hand-in-hand with results because each result will have a parent sample via the "sample_nid" property. A single sample will be the parent for multiple results.
  3. Results: results are simply the contaminant and the value measured. Once all samples and results are queried, they can be programatically paired up using the "sample_nid" property.
  4. LODs: LOD stands for "limit of detection" which is the lowest concentration that our laboratory can measure (or detect) a contaminant. The LOD for some samples can be found in the respective standards query, but some samples will contain an "lod_run". That "lod_run" value can be paired up with values returned in this endpoint.

For example...
If you want all LAB Inorganic Water samples, select the respective values form the dropdowns below: Method = LAB, Category = inorganic, Type = water. This might return more records than you're interest in, so you can refine this by selecting a contaminant as well.

Pagination
You can control how many records are returned in each query by modifying "items_per_page" to any of the following values: 100, 200, 500. You can use the "offset" property to fetch subsequent pages. For example, to retrieve the first 100 records: "items_per_page100&offset=0", then to retrieve the next 100: "items_per_page100&offset=100".