Skip to content

Commit b23f9a4

Browse files
committed
measurements updates
1 parent 576cfb9 commit b23f9a4

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

src/content/docs/resources/measurements.mdx

+19-19
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ as their original values and different levels of aggregation.
1515
In addition to providing raw measurement values as reported by providers, the
1616
API provides options for rolling up data into different aggregation periods.
1717

18-
### Resources
18+
## Resources
1919

20-
#### Measurements
20+
### Measurements
2121

2222
`https://api.openaq.org/v3/sensors/{sensors_id}/measurements`
2323

24-
The `measurements` resource represents the original measurement value as
24+
The `measurements` resource is the original measurement value as
2525
reported by the upstream source.
2626

27-
#### Hours
27+
### Hours
2828

2929
`https://api.openaq.org/v3/sensors/{sensors_id}/hours`
3030

@@ -36,18 +36,18 @@ The `hours` resource is the hourly average (mean) value of measurements.
3636
`measurements` resource are equivalent.
3737
</Aside>
3838

39-
#### Days
39+
### Days
4040

4141
`https://api.openaq.org/v3/sensors/{sensors_id}/days`
4242

43-
The days resource is the daily average (mean), computed from the hourly average
43+
The `days` resource is the daily average (mean), computed from the hourly average
4444
values from 01:00 to 0:00 in local time.
4545

46-
#### Years
46+
### Years
4747

4848
`https://api.openaq.org/v3/sensors/{sensors_id}/years`
4949

50-
The years resource is the yearly average (mean), computed from the hourly
50+
The `years` resource is the yearly average (mean), computed from the hourly
5151
average values from January 01 at 01:00 to December 31 0:00 in local time.
5252

5353
### Aggregation Periods
@@ -61,7 +61,7 @@ For most reliable results, limit queries to smaller time periods using the `date
6161
`date_to` query parameters.
6262
</Aside>
6363

64-
#### Hourly
64+
### Hourly
6565

6666
`https://api.openaq.org/v3/sensors/{sensors_id}/measurements/hourly`
6767

@@ -74,7 +74,7 @@ the selected time range.
7474
preferred resource.
7575
</Aside>
7676

77-
#### Daily
77+
### Daily
7878

7979
`https://api.openaq.org/v3/sensors/{sensors_id}/measurements/daily`
8080

@@ -89,7 +89,7 @@ selected time range.
8989
resource.
9090
</Aside>
9191

92-
#### Monthly
92+
### Monthly
9393

9494
`https://api.openaq.org/v3/sensors/{sensors_id}/measurements/monthly`
9595

@@ -100,7 +100,7 @@ selected time range.
100100
The `monthly` aggregator returns the average (mean) value for each month across
101101
the selected time range.
102102

103-
#### Yearly
103+
### Yearly
104104

105105
`https://api.openaq.org/v3/sensors/{sensors_id}/measurements/yearly`
106106

@@ -117,7 +117,7 @@ the selected time range.
117117
resource.
118118
</Aside>
119119

120-
#### Hour of day
120+
### Hour of day
121121

122122
`https://api.openaq.org/v3/sensors/{sensors_id}/hours/hourofday`
123123

@@ -126,7 +126,7 @@ The `hourofday` aggregator returns the average (mean) value for each hour in a
126126
trends on an hourly basis, offering insights into daily patterns and peak
127127
pollution times, such as diurnal patterns.
128128

129-
#### Day of week
129+
### Day of week
130130

131131
`https://api.openaq.org/v3/sensors/{sensors_id}/measurements/dayofweek`
132132

@@ -137,7 +137,7 @@ week (Monday-Sunday), across the selected time range. This allows analyzing air
137137
quality trends on an daily basis, offering insights into daily patterns and peak
138138
pollution days.
139139

140-
#### Month of year
140+
### Month of year
141141

142142
`https://api.openaq.org/v3/sensors/{sensors_id}/measurements/monthofyear`
143143

@@ -150,9 +150,9 @@ a year (January-December), across the selected time range. This allows analyzing
150150
air quality trends on an monthly basis, offering insights into seasonal
151151
patterns.
152152

153-
### Response details
153+
## Response details
154154

155-
#### Summary
155+
### Summary
156156

157157
The summary object provides summary statistics about a aggregated measurement
158158
value. The object includes the minimum and maximum values, quartile values
@@ -174,7 +174,7 @@ null.
174174
}
175175
```
176176

177-
#### Coverage
177+
### Coverage
178178

179179
The coverage object provides information on the coverage of measurements when
180180
aggregating values over time. When requesting `measuremements` this field is
@@ -200,7 +200,7 @@ of 100.
200200
}
201201
```
202202

203-
## Key fields:
203+
## Key fields
204204

205205
- value - The average (mean) value in aggregate, except in the `measurements`
206206
resource `value` is the original reported measurement value.

0 commit comments

Comments
 (0)