# Metrics

{% hint style="info" %}
There are a variety of different data sets and aggregations provided by Occuspace in this API, and it is important to use the correct configuration for your given use case. We highly encourage our customers to reach out to us when starting to use this API. Occuspace Customer Success Managers can help identify which particular metric, data set, and aggregation makes the most sense to utilize.
{% endhint %}

## Get Occupancy metrics for a location

> Returns historical occupancy metrics for a specific location over a given date range and interval. Supports optional hour and day filters for all intervals.

```json
{"openapi":"3.0.0","info":{"title":"Occuspace Customer API","version":"2.0.0"},"servers":[{"url":"https://api.occuspace.io/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OccupancyResponse":{"type":"object","required":["location_id","name","capacity","metric","interval","time_range","days_of_week","hour_range","data","pagination"],"properties":{"location_id":{"type":"integer","description":"The ID of the location."},"name":{"type":"string","description":"The name of the location."},"capacity":{"type":"integer","description":"The total capacity of the location."},"metric":{"type":"string","description":"The metric type returned."},"interval":{"type":"string","description":"The time interval used to aggregate the data.","enum":["daily","hourly","weekly","monthly","60min","30min","15min"]},"time_range":{"$ref":"#/components/schemas/TimeRange"},"days_of_week":{"type":"array","description":"The days of the week included in the response data. Reflects the days_filter parameter if provided, otherwise includes all days. 1=Sunday through 7=Saturday.","items":{"type":"integer","minimum":1,"maximum":7}},"hour_range":{"$ref":"#/components/schemas/HourRange"},"data":{"type":"array","description":"The occupancy data points for the requested time range and interval.","items":{"$ref":"#/components/schemas/OccupancyDataPoint"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"TimeRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"The start of the requested time range in UTC."},"end":{"type":"string","format":"date-time","description":"The end of the requested time range in UTC."}}},"HourRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"integer","description":"The start hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23},"end":{"type":"integer","description":"The end hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23}}},"OccupancyDataPoint":{"type":"object","required":["timestamp","window_start","window_end","avg_occupancy","avg_utilization_percentage","peak_occupancy","peak_utilization_percentage"],"properties":{"timestamp":{"type":"string","format":"date-time","description":"The start timestamp of the data point window in UTC."},"window_start":{"type":"string","format":"date-time","description":"The start of the aggregation window in UTC."},"window_end":{"type":"string","format":"date-time","description":"The end of the aggregation window in UTC."},"avg_occupancy":{"type":"integer","description":"The average number of people during the window."},"avg_utilization_percentage":{"type":"number","format":"float","description":"The average occupancy as a fraction of total capacity during the window."},"peak_occupancy":{"type":"integer","description":"The highest number of people detected at any point during the window."},"peak_utilization_percentage":{"type":"number","format":"float","description":"The peak occupancy as a fraction of total capacity during the window."}}},"Pagination":{"type":"object","required":["prev_cursor","next_cursor","has_more"],"properties":{"prev_cursor":{"type":"string","nullable":true},"next_cursor":{"type":"string","nullable":true},"has_more":{"type":"boolean"}}},"ErrorResponse":{"type":"object","required":["type","title","status","detail","instance","request_id"],"description":"Error response following the RFC 7807 Problem Details standard","properties":{"type":{"type":"string","format":"uri","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type"},"status":{"type":"integer","description":"The HTTP status code for this problem"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem, including relevant identifiers to help with debugging"},"instance":{"type":"string","format":"uri-reference","description":"The specific API path that generated the error"},"request_id":{"type":"string","format":"uuid","description":"A unique identifier for the request, useful for tracing and support"}}}}},"paths":{"/locations/{id}/occupancy":{"get":{"summary":"Get Occupancy metrics for a location","description":"Returns historical occupancy metrics for a specific location over a given date range and interval. Supports optional hour and day filters for all intervals.","tags":["Metrics"],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the location.","schema":{"type":"integer"}},{"name":"start_date","in":"query","required":true,"description":"The start date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"interval","in":"query","required":false,"description":"The time interval to aggregate occupancy data by.","schema":{"type":"string","enum":["daily","hourly","weekly","monthly","60min","30min","15min"],"default":"daily"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of data points to return per page. Defaults to 1000 if not specified.","schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","required":false,"description":"Cursor value from the previous response's pagination object used to fetch the next or previous page of results.","schema":{"type":"string"}},{"name":"start_hour_filter","in":"query","required":false,"description":"Filter data to only include readings at or after this hour of the day. Valid values are 0-24. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"end_hour_filter","in":"query","required":false,"description":"Filter data to only include readings before or at this hour of the day. Valid values are 0-24. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"days_filter","in":"query","required":false,"description":"Filter data to only include specific days of the week. Provided as a string of day codes with no separator where 1=Sunday, 2=Monday, 3=Tuesday, 4=Wednesday, 5=Thursday, 6=Friday, 7=Saturday. For example '23456' means Monday through Friday. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"string","pattern":"^[1-7]+$"}}],"responses":{"200":{"description":"Occupancy metrics for the location","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OccupancyResponse"}}}},"400":{"description":"Bad request — one or more request parameters are invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Location not found or not accessible with the provided credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

***

## Get Traffic metrics for a location

> Returns visits for a specific location over a given date range and interval. Traffic represents the total number of people who entered the location during each interval window. Supports optional hour and day filters for all intervals.

```json
{"openapi":"3.0.0","info":{"title":"Occuspace Customer API","version":"2.0.0"},"servers":[{"url":"https://api.occuspace.io/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"TrafficResponse":{"type":"object","required":["location_id","name","capacity","metric","interval","time_range","days_of_week","hour_range","data","pagination"],"properties":{"location_id":{"type":"integer","description":"The ID of the location."},"name":{"type":"string","description":"The name of the location."},"capacity":{"type":"integer","description":"The total capacity of the location."},"metric":{"type":"string","description":"The metric type returned."},"interval":{"type":"string","description":"The time interval used to aggregate the data.","enum":["daily","weekly","monthly","60min"]},"time_range":{"$ref":"#/components/schemas/TimeRange"},"days_of_week":{"type":"array","description":"The days of the week included in the response data. Reflects the days_filter parameter if provided, otherwise includes all days. 1=Sunday through 7=Saturday.","items":{"type":"integer","minimum":1,"maximum":7}},"hour_range":{"$ref":"#/components/schemas/HourRange"},"data":{"type":"array","description":"The traffic data points for the requested time range and interval.","items":{"$ref":"#/components/schemas/TrafficDataPoint"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"TimeRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"The start of the requested time range in UTC."},"end":{"type":"string","format":"date-time","description":"The end of the requested time range in UTC."}}},"HourRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"integer","description":"The start hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23},"end":{"type":"integer","description":"The end hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23}}},"TrafficDataPoint":{"type":"object","required":["timestamp","window_start","window_end","traffic"],"properties":{"timestamp":{"type":"string","format":"date-time","description":"The start timestamp of the data point window in UTC."},"window_start":{"type":"string","format":"date-time","description":"The start of the aggregation window in UTC."},"window_end":{"type":"string","format":"date-time","description":"The end of the aggregation window in UTC."},"traffic":{"type":"integer","description":"The total number of people who entered the location during the window."}}},"Pagination":{"type":"object","required":["prev_cursor","next_cursor","has_more"],"properties":{"prev_cursor":{"type":"string","nullable":true},"next_cursor":{"type":"string","nullable":true},"has_more":{"type":"boolean"}}},"ErrorResponse":{"type":"object","required":["type","title","status","detail","instance","request_id"],"description":"Error response following the RFC 7807 Problem Details standard","properties":{"type":{"type":"string","format":"uri","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type"},"status":{"type":"integer","description":"The HTTP status code for this problem"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem, including relevant identifiers to help with debugging"},"instance":{"type":"string","format":"uri-reference","description":"The specific API path that generated the error"},"request_id":{"type":"string","format":"uuid","description":"A unique identifier for the request, useful for tracing and support"}}}}},"paths":{"/locations/{id}/traffic":{"get":{"summary":"Get Traffic metrics for a location","description":"Returns visits for a specific location over a given date range and interval. Traffic represents the total number of people who entered the location during each interval window. Supports optional hour and day filters for all intervals.","tags":["Metrics"],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the location.","schema":{"type":"integer"}},{"name":"start_date","in":"query","required":true,"description":"The start date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"interval","in":"query","required":false,"description":"The time interval to aggregate traffic data by. Defaults to daily if not specified.","schema":{"type":"string","enum":["daily","weekly","monthly","60min"],"default":"daily"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of data points to return per page. Defaults to 1000 if not specified.","schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","required":false,"description":"Cursor value from the previous response's pagination object used to fetch the next or previous page of results.","schema":{"type":"string"}},{"name":"start_hour_filter","in":"query","required":false,"description":"Filter data to only include readings at or after this hour of the day. Valid values are 0-23. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"end_hour_filter","in":"query","required":false,"description":"Filter data to only include readings before or at this hour of the day. Valid values are 0-23. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"days_filter","in":"query","required":false,"description":"Filter data to only include specific days of the week. Provided as a string of day codes with no separator where 1=Sunday, 2=Monday, 3=Tuesday, 4=Wednesday, 5=Thursday, 6=Friday, 7=Saturday. For example '23456' means Monday through Friday. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"string","pattern":"^[1-7]+$"}}],"responses":{"200":{"description":"Traffic metrics for the location","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrafficResponse"}}}},"400":{"description":"Bad request — one or more request parameters are invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Location not found or not accessible with the provided credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

***

## Get Dwell Time metrics for a location

> Returns historical dwell time metrics for a specific location over a given date range and interval. Dwell time represents how long people stayed in the location during each interval window, expressed in seconds. Supports optional hour and day filters for all intervals.

```json
{"openapi":"3.0.0","info":{"title":"Occuspace Customer API","version":"2.0.0"},"servers":[{"url":"https://api.occuspace.io/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DwellTimeResponse":{"type":"object","required":["location_id","name","capacity","metric","interval","time_range","days_of_week","hour_range","data","pagination"],"properties":{"location_id":{"type":"integer","description":"The ID of the location."},"name":{"type":"string","description":"The name of the location."},"capacity":{"type":"integer","description":"The total capacity of the location."},"metric":{"type":"string","description":"The metric type returned."},"interval":{"type":"string","description":"The time interval used to aggregate the data.","enum":["daily","weekly","monthly"]},"time_range":{"$ref":"#/components/schemas/TimeRange"},"days_of_week":{"type":"array","description":"The days of the week included in the response data. Reflects the days_filter parameter if provided, otherwise includes all days. 1=Sunday through 7=Saturday.","items":{"type":"integer","minimum":1,"maximum":7}},"hour_range":{"$ref":"#/components/schemas/HourRange"},"data":{"type":"array","description":"The dwell time data points for the requested time range and interval.","items":{"$ref":"#/components/schemas/DwellTimeDataPoint"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"TimeRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"The start of the requested time range in UTC."},"end":{"type":"string","format":"date-time","description":"The end of the requested time range in UTC."}}},"HourRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"integer","description":"The start hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23},"end":{"type":"integer","description":"The end hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23}}},"DwellTimeDataPoint":{"type":"object","required":["timestamp","window_start","window_end","avg_dwell_time","peak_dwell_time"],"properties":{"timestamp":{"type":"string","format":"date-time","description":"The start timestamp of the data point window in UTC."},"window_start":{"type":"string","format":"date-time","description":"The start of the aggregation window in UTC."},"window_end":{"type":"string","format":"date-time","description":"The end of the aggregation window in UTC."},"avg_dwell_time":{"type":"integer","nullable":true,"description":"The average time in minutes people spent in the location during the window. Null if no data was available for this window."},"peak_dwell_time":{"type":"integer","nullable":true,"description":"The longest time in minutes any individual spent in the location during the window. Null if no data was available for this window."}}},"Pagination":{"type":"object","required":["prev_cursor","next_cursor","has_more"],"properties":{"prev_cursor":{"type":"string","nullable":true},"next_cursor":{"type":"string","nullable":true},"has_more":{"type":"boolean"}}},"ErrorResponse":{"type":"object","required":["type","title","status","detail","instance","request_id"],"description":"Error response following the RFC 7807 Problem Details standard","properties":{"type":{"type":"string","format":"uri","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type"},"status":{"type":"integer","description":"The HTTP status code for this problem"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem, including relevant identifiers to help with debugging"},"instance":{"type":"string","format":"uri-reference","description":"The specific API path that generated the error"},"request_id":{"type":"string","format":"uuid","description":"A unique identifier for the request, useful for tracing and support"}}}}},"paths":{"/locations/{id}/dwell_time":{"get":{"summary":"Get Dwell Time metrics for a location","description":"Returns historical dwell time metrics for a specific location over a given date range and interval. Dwell time represents how long people stayed in the location during each interval window, expressed in seconds. Supports optional hour and day filters for all intervals.","tags":["Metrics"],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the location.","schema":{"type":"integer"}},{"name":"start_date","in":"query","required":true,"description":"The start date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"interval","in":"query","required":false,"description":"The time interval to aggregate dwell time data by. Defaults to daily if not specified.","schema":{"type":"string","enum":["daily","weekly","monthly"],"default":"daily"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of data points to return per page. Defaults to 1000 if not specified.","schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","required":false,"description":"Cursor value from the previous response's pagination object used to fetch the next or previous page of results.","schema":{"type":"string"}},{"name":"start_hour_filter","in":"query","required":false,"description":"Filter data to only include readings at or after this hour of the day. Valid values are 0-23. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"end_hour_filter","in":"query","required":false,"description":"Filter data to only include readings before or at this hour of the day. Valid values are 0-23. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"days_filter","in":"query","required":false,"description":"Filter data to only include specific days of the week. Provided as a string of day codes with no separator where 1=Sunday, 2=Monday, 3=Tuesday, 4=Wednesday, 5=Thursday, 6=Friday, 7=Saturday. For example '23456' means Monday through Friday. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"string","pattern":"^[1-7]+$"}}],"responses":{"200":{"description":"Dwell time metrics for the location","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DwellTimeResponse"}}}},"400":{"description":"Bad request — one or more request parameters are invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Location not found or not accessible with the provided credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

***

## Get Availability metrics for a location

> Returns historical availability metrics for a specific location over a given date range and interval. Availability represents the percentage of time the location was unoccupied during each interval window. Null values indicate no data was available for that window, typically on days outside operating hours. Supports optional hour and day filters for daily, weekly, and monthly intervals.

```json
{"openapi":"3.0.0","info":{"title":"Occuspace Customer API","version":"2.0.0"},"servers":[{"url":"https://api.occuspace.io/v2"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"AvailabilityResponse":{"type":"object","required":["location_id","name","capacity","metric","interval","time_range","days_of_week","hour_range","data","pagination"],"properties":{"location_id":{"type":"integer","description":"The ID of the location."},"name":{"type":"string","description":"The name of the location."},"capacity":{"type":"integer","description":"The total capacity of the location."},"metric":{"type":"string","description":"The metric type returned."},"interval":{"type":"string","description":"The time interval used to aggregate the data.","enum":["daily","hourly","weekly","monthly","60min","30min","15min"]},"time_range":{"$ref":"#/components/schemas/TimeRange"},"days_of_week":{"type":"array","description":"The days of the week included in the response data. Reflects the days_filter parameter if provided, otherwise includes all days. 1=Sunday through 7=Saturday.","items":{"type":"integer","minimum":1,"maximum":7}},"hour_range":{"$ref":"#/components/schemas/HourRange"},"data":{"type":"array","description":"The availability data points for the requested time range and interval.","items":{"$ref":"#/components/schemas/AvailabilityDataPoint"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"TimeRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"string","format":"date-time","description":"The start of the requested time range in UTC."},"end":{"type":"string","format":"date-time","description":"The end of the requested time range in UTC."}}},"HourRange":{"type":"object","required":["start","end"],"properties":{"start":{"type":"integer","description":"The start hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23},"end":{"type":"integer","description":"The end hour filter applied to the request. Defaults to the assigned operating hours for this location.","minimum":0,"maximum":23}}},"AvailabilityDataPoint":{"type":"object","required":["timestamp","window_start","window_end","availability_percentage"],"properties":{"timestamp":{"type":"string","format":"date-time","description":"The start timestamp of the data point window in UTC."},"window_start":{"type":"string","format":"date-time","description":"The start of the aggregation window in UTC."},"window_end":{"type":"string","format":"date-time","description":"The end of the aggregation window in UTC."},"availability_percentage":{"type":"number","format":"float","nullable":true,"description":"The percentage of time the location was unoccupied during the window, expressed as a fraction between 0 and 1. Null if no data was available for this window, typically on days outside operating hours."}}},"Pagination":{"type":"object","required":["prev_cursor","next_cursor","has_more"],"properties":{"prev_cursor":{"type":"string","nullable":true},"next_cursor":{"type":"string","nullable":true},"has_more":{"type":"boolean"}}},"ErrorResponse":{"type":"object","required":["type","title","status","detail","instance","request_id"],"description":"Error response following the RFC 7807 Problem Details standard","properties":{"type":{"type":"string","format":"uri","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type"},"status":{"type":"integer","description":"The HTTP status code for this problem"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem, including relevant identifiers to help with debugging"},"instance":{"type":"string","format":"uri-reference","description":"The specific API path that generated the error"},"request_id":{"type":"string","format":"uuid","description":"A unique identifier for the request, useful for tracing and support"}}}}},"paths":{"/locations/{id}/availability":{"get":{"summary":"Get Availability metrics for a location","description":"Returns historical availability metrics for a specific location over a given date range and interval. Availability represents the percentage of time the location was unoccupied during each interval window. Null values indicate no data was available for that window, typically on days outside operating hours. Supports optional hour and day filters for daily, weekly, and monthly intervals.","tags":["Metrics"],"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the location.","schema":{"type":"integer"}},{"name":"start_date","in":"query","required":true,"description":"The start date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the requested time range in YYYY-MM-DD format.","schema":{"type":"string","format":"date"}},{"name":"interval","in":"query","required":false,"description":"The time interval to aggregate availability data by. Defaults to daily if not specified.","schema":{"type":"string","enum":["daily","hourly","weekly","monthly","60min","30min","15min"],"default":"daily"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of data points to return per page. Defaults to 1000 if not specified.","schema":{"type":"integer","default":1000}},{"name":"cursor","in":"query","required":false,"description":"Cursor value from the previous response's pagination object used to fetch the next or previous page of results.","schema":{"type":"string"}},{"name":"start_hour_filter","in":"query","required":false,"description":"Filter data to only include readings at or after this hour of the day. Valid values are 0-23. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"end_hour_filter","in":"query","required":false,"description":"Filter data to only include readings before or at this hour of the day. Valid values are 0-23. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"integer","minimum":0,"maximum":23}},{"name":"days_filter","in":"query","required":false,"description":"Filter data to only include specific days of the week. Provided as a string of day codes with no separator where 1=Sunday, 2=Monday, 3=Tuesday, 4=Wednesday, 5=Thursday, 6=Friday, 7=Saturday. For example '23456' means Monday through Friday. Only supported for daily, weekly, and monthly intervals.","schema":{"type":"string","pattern":"^[1-7]+$"}}],"responses":{"200":{"description":"Availability metrics for the location","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityResponse"}}}},"400":{"description":"Bad request — one or more request parameters are invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Location not found or not accessible with the provided credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```