tsgettoolbox.wdfn_time_series_metadata#

tsgettoolbox.wdfn_time_series_metadata(*, geometry: Any = None, id: str = None, unit_of_measure: str = None, parameter_name: str = None, parameter_code: str = None, statistic_id: str = None, hydrologic_unit_code: str = None, state_name: str = None, last_modified: str = None, begin: str = None, end: str = None, begin_utc: str = None, end_utc: str = None, computation_period_identifier: str = None, computation_identifier: str = None, thresholds: str = None, sublocation_identifier: str = None, primary: str = None, monitoring_location_id: str = None, web_description: str = None, parameter_description: str = None, parent_time_series_id: str = None, data_gap_interval: str = None)#

US:station:::USGS WDFN Time series metadata as table

Daily data and continuous measurements are grouped into time series, which represent a collection of observations of a single parameter, potentially aggregated using a standard statistic, at a single monitoring location. This endpoint provides metadata about those time series, including their operational thresholds, units of measurement, and when the earliest and most recent observations in a time series occurred.

Parameters:

  • geometry – The geometry parameter is used to filter the results by a specific geographic area. The value should be a GeoJSON geometry object.

  • id – A unique identifier representing a single time series. This corresponds to the “time_series_id” field in other endpoints.

  • unit_of_measure – A human-readable description of the units of measurement associated with an observation.

  • parameter_name – A human-understandable name corresponding to parameter_code.

  • parameter_code – 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/v1/collections/parameter-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/parameter-codes/items).

  • statistic_id – A code corresponding to the statistic an observation represents. Example codes include 00001 (max), 00002 (min), and 00003 (mean). A complete list of codes and their descriptions can be found at [https://api.waterdata.usgs.gov/ogcapi/v1/collections/statistic-codes/items](https://api.waterdata.usgs.gov/ogcapi/v1/collections/statistic-codes/items).

  • hydrologic_unit_code – The hydrologic unit code (HUC) for the monitoring location. Supports prefix matching — querying with a shorter HUC (e.g. “04”) matches all locations within that hydrologic region.

  • state_name – The name of the state or state equivalent in which the monitoring location is located.

  • last_modified –

    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. You 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). Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../2018-03-18T12:31:12Z”

    • Duration objects: “P1M” for data from the past month or “PT36H” for the last 36 hours

    Only features that have a last_modified that intersects the value of datetime are selected.

  • begin – This field contains the same information as “begin_utc”, but in the local time of the monitoring location. It is retained for backwards compatibility, but will be removed in V1 of these APIs.

  • end – This field contains the same information as “end_utc”, but in the local time of the monitoring location. It is retained for backwards compatibility, but will be removed in V1 of these APIs.

  • begin_utc –

    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. You 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). Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../2018-03-18T12:31:12Z”

    • Duration objects: “P1M” for data from the past month or “PT36H” for the last 36 hours

    Only features that have a begin_utc that intersects the value of datetime are selected.

  • end_utc –

    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”. You 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). Examples:

    • A date-time: “2018-02-12T23:20:50Z”

    • A bounded interval: “2018-02-12T00:00:00Z/2018-03-18T12:31:12Z”

    • Half-bounded intervals: “2018-02-12T00:00:00Z/..” or “../2018-03-18T12:31:12Z”

    • Duration objects: “P1M” for data from the past month or “PT36H” for the last 36 hours

    Only features that have a end_utc that intersects the value of datetime are selected.

  • computation_period_identifier – Indicates the period of data used for any statistical computations.

  • computation_identifier – Indicates the computation performed to calculate this time series. Values of “Instantaneous” reflect point measurements.

  • thresholds – Thresholds represent known numeric limits for a time series, for example the historic maximum value for a parameter or a level below which a sensor is non-operative. These thresholds are sometimes used to automatically determine if an observation is erroneous due to sensor error, and therefore shouldn’t be included in the time series.

  • sublocation_identifier – An optional human-readable identifier used to specify where measurements are recorded at a monitoring location.

  • primary – A flag identifying if the time series is a “primary” time series. “Primary” time series (which have this flag) are standard observations which undergo [Bureau review and approval processes](https://www.usgs.gov/survey-manual/5028-fundamental-science-practices-review-and-approval-scientific-data-release). Non-primary time series, which will have missing values for “primary”, are provisional datasets made available to meet the need for timely best science and to assist with daily operations which need real-time information. Non-primary time series data are only retained by this system for 120 days. See the [USGS Provisional Data Statement](https://waterdata.usgs.gov/provisional-data- statement/) for more information.

  • monitoring_location_id – 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).

  • web_description – An optional description of the time series. WDFN and other USGS data dissemination products use this field, in combination with sublocation_identifier, to distinguish the differences between multiple time series for the same parameter code, statistic code, and monitoring location.

  • parameter_description – A description of what the parameter code represents, as used by WDFN and other USGS data dissemination products.

  • parent_time_series_id – The unique identifier representing the parent or “upchain” time series that a daily values time series is generated from. Daily values time series have one and only one parent time series.

  • data_gap_interval – The time interval threshold used for gap detection in the time series.