GET
/
cities
/
{geo_id}
/
metrics
/
monthly
curl --request GET \
  --url https://api.shovels.ai/v2/cities/{geo_id}/metrics/monthly \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "property_type": "<string>",
      "tag": "<string>",
      "permit_count": 123,
      "contractor_count": 123,
      "avg_construction_duration": 123,
      "avg_approval_duration": 123,
      "date": "2023-12-25",
      "total_job_value": 123,
      "avg_inspection_pass_rate": 123,
      "geo_id": "<string>"
    }
  ],
  "page": 123,
  "size": 123,
  "next_page": 123
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
geo_id
string
required

Filter by the specified city ID.

Query Parameters

​
metric_from
string
required

Start date for metrics (inclusive)

​
metric_to
string
required

End date for metrics (inclusive)

​
property_type
string
required

Filter by property type

​
tag
string
required

Filter by tag

​
page
integer
default:1
Required range: x >= 1
​
size
integer
default:50
Required range: 1 <= x <= 100

Response

200
application/json
Paginated list of city metrics

Schema for City Metrics in list response.

​
items
object[]
required

The list of items returned in the response following given criteria.

​
page
integer
required

The page number of the response.

​
size
integer
required

The number of items returned in the response.

​
next_page
integer | null
required

The next page number of the response.

Was this page helpful?