{ "opencollection": "1.0.0", "info": { "name": "USGS Water Data OGC APIs agency-codes field-measurements-metadata API", "version": "0.56.0" }, "items": [ { "info": { "name": "field-measurements-metadata", "type": "folder" }, "items": [ { "info": { "name": "Get Field measurements metadata metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata", "params": [ { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ] }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" }, { "info": { "name": "Get Field measurements metadata items", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata/items", "params": [ { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." }, { "name": "bbox", "value": "", "type": "query", "description": "Only features that have a geometry that intersects the bounding box are selected.The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth)." }, { "name": "limit", "value": "", "type": "query", "description": "The optional limit parameter limits the number of items that are presented in the response document (maximum=50000, default=10)." }, { "name": "crs", "value": "", "type": "query", "description": "Indicates the coordinate reference system for the results." }, { "name": "bbox-crs", "value": "", "type": "query", "description": "Indicates the coordinate reference system for the given bbox coordinates." }, { "name": "properties", "value": "", "type": "query", "description": "The properties that should be included. The parameter value is a comma-separated list of property names." }, { "name": "skipGeometry", "value": "", "type": "query", "description": "This option can be used to skip response geometries for each feature." }, { "name": "sortby", "value": "", "type": "query", "description": "Specifies a comma-separated list of property names by which the response shall be sorted. If the property name is preceded by a plus (+) sign it indicates an ascending sort for that property. If the property name is preceded by a minus (-) sign it indicates a descending sort for that property. If the property is not preceded by a plus or minus, then the default sort order implied is ascending (+). \n\nOnly a single page of data can be returned when specifying sortby. If you need more than a single page of data, don't specify a sortby value and sort the full data set after it's been downloaded." }, { "name": "offset", "value": "", "type": "query", "description": "The optional offset parameter indicates the index within the result set from which the server shall begin presenting results in the response document. The first element has an index of 0 (default)." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifier representing a single collection series. This corresponds to the `field_measurement_series_id` field in the `field-measurements` endpoint. Collection series are defined as the set of field measurements at a given monitoring location for a single parameter code using a single reading type.\n Split parameters are enabled for this field, so you can supply multiple values separated by commas." }, { "name": "monitoring_location_id", "value": "", "type": "query", "description": "A unique identifier representing a single monitoring location. This corresponds to the `id` field in the `monitoring-locations` endpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas." }, { "name": "parameter_code", "value": "", "type": "query", "description": "Parameter codes are 5-digit codes used to identify the constituent measured and the units of measure. A complete list of parameter codes and associated groupings can be found at [https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items).\n Split parameters are enabled for this field, so you can supply multiple values separated by commas." }, { "name": "parameter_name", "value": "", "type": "query", "description": "A human-understandable name corresponding to `parameter_code`." }, { "name": "parameter_description", "value": "", "type": "query", "description": "A description of what the parameter code represents, as used by WDFN and other USGS data dissemination products.\n" }, { "name": "begin", "value": "", "type": "query", "description": "The datetime of the earliest observation in the time series. Together with `end_utc`, this field represents the period of record of a time series. Note that some time series may have large gaps in their collection record.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `begin_utc` that intersects the value of datetime are selected.\n" }, { "name": "end", "value": "", "type": "query", "description": "The datetime of the most recent observation in the time series. Data returned by this endpoint updates at most once per day, and potentially less frequently than that, and as such there may be more recent observations within a time series than the time series `end_utc` value reflects. Together with `begin_utc`, this field represents the period of record of a time series. It is additionally used to determine whether a time series is \"active\".\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `end_utc` that intersects the value of datetime are selected.\n" }, { "name": "last_modified", "value": "", "type": "query", "description": "The last time a record was refreshed in our database. This may happen due to regular operational processes and does not necessarily indicate anything about the measurement has changed.\nYou can query this field using date-times or intervals, adhering to RFC 3339, or using ISO 8601 duration objects. Intervals may be bounded or half-bounded (double-dots at start or end).\nExamples:\n\n - A date-time: \"2018-02-12T23:20:50Z\"\n - A bounded interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\n - Half-bounded intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\n - Duration objects: \"P1M\" for data from the past month or \"PT36H\" for the last 36 hours\n\nOnly features that have a `last_modified` that intersects the value of datetime are selected.\n" }, { "name": "filter", "value": "", "type": "query", "description": "CQL Text filter expression. CQL JSON cannot be used here, only in the body. \nSee also: https://docs.pygeoapi.io/en/latest/cql.html \n\nExample: time_series_id IN ('64ee32f5350a4ec4967435dcd2e364ea', '3e55d9c2d8a54bec9ca5e292b07d5a96')" } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" }, { "info": { "name": "Get Field measurements metadata items with CQL2", "type": "http" }, "http": { "method": "POST", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata/items", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" }, { "info": { "name": "Options for Field measurements metadata items", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata/items", "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" }, { "info": { "name": "Get Field measurements metadata item by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata/items/:featureId", "params": [ { "name": "crs", "value": "", "type": "query", "description": "Indicates the coordinate reference system for the results." }, { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" }, { "info": { "name": "Options for Field measurements metadata item by id", "type": "http" }, "http": { "method": "OPTIONS", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata/items/:featureId", "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" }, { "info": { "name": "Get Field measurements metadata queryables", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata/queryables", "params": [ { "name": "properties", "value": "", "type": "query", "description": "The properties that should be included. The parameter value is a comma-separated list of property names." }, { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "profile", "value": "", "type": "query", "description": "The profile to be applied to a given request" }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" }, { "info": { "name": "Get Field measurements metadata schema", "type": "http" }, "http": { "method": "GET", "url": "https://api.waterdata.usgs.gov/ogcapi/v0/collections/field-measurements-metadata/schema", "params": [ { "name": "f", "value": "", "type": "query", "description": "The optional f parameter indicates the output format which the server shall provide as part of the response document. The default format is GeoJSON. CSV is also available." }, { "name": "lang", "value": "", "type": "query", "description": "The optional lang parameter instructs the server return a response in a certain language, if supported. If the language is not among the available values, the Accept-Language header language will be used if it is supported. If the header is missing, the default server language is used. Note that providers may only support a single language (or often no language at all), that can be different from the server language. Language strings can be written in a complex (e.g. \"fr-CA,fr;q=0.9,en-US;q=0.8,en;q=0.7\"), simple (e.g. \"de\") or locale-like (e.g. \"de-CH\" or \"fr_BE\") fashion." } ], "auth": { "type": "apikey", "key": "api_key", "value": "{{api_key}}", "placement": "query" } }, "docs": "This endpoint provides metadata about field measurement collections, including when the earliest and most recent observations for a parameter occurred at a monitoring location and its units.\n" } ] } ], "bundled": true }