Documentation for "/api/v1/cmp/huc-8-percents":

Documentation score: Route: 100% Fields: 100%

Description:

Annual summary of transparency for stations in the Citizen Monitoring Program.

Search parameters:

One or more of the following search parameters need to be specified in order to retrieve data:
Parameter nameRequiredDescription
huc8 The 8-digit hydrological unit code.
stationType Type of station. 'River/Stream' or 'Lake Station' or 'Lake'.

Additional parameters:

The following, optional, parameters may be specified:
Parameter nameDescription
format The desired return format. Valid formats are: {json, jsonp, text, csv, xls, ods, and tab}. The default is json.
callback The JSONP callback function name (Note that format needs to be "jsonp").
fields The comma-separated-list of the field names to return from the query. The default is to return all available fields.
nullValue Value to substitute in place of null values. The default is to return null values as "null" (per JSON.org).
limit The number of records to limit the result set to. Behaves like the SQL standard LIMIT clause.
offset Used with Limit-- the record number to start retrieving from. Behaves like the SQL standard OFFSET clause.

Result Set Definitions:

Field nameDescription
huc8 The 8-digit hydrological unit code.
monitoringYear The year the monitoring took place.
stationType Type of station. 'River/Stream' or 'Lake Station' or 'Lake'.
transparencyRatingColor Color used on graph to represent a color representing Secchi transparency, from poor to excellent. Key: Red=poor, yellow=fair, green=good, light blue=very good, dark blue= excellent.
transparencyRatingValue Percentage of readings taken in each Secchi transparency category.

Example Queries: