Skip to main content
GET
/
addresses
/
{geo_id}
/
metrics
/
monthly
Get Address Monthly Metrics
curl --request GET \
  --url https://api.shovels.ai/v2/addresses/{geo_id}/metrics/monthly \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "geo_id": "abc123",
      "tag": "all",
      "permit_count": 42,
      "contractor_count": 15,
      "avg_construction_duration": 60,
      "avg_approval_duration": 14,
      "total_job_value": 12500000,
      "avg_inspection_pass_rate": 85,
      "date": "2023-01-01"
    }
  ],
  "size": 1,
  "next_cursor": "c29tZS1jdXJzb3I",
  "pagination_type": "cursor"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
geo_id
string
required

Filter by the specified geolocation ID.

Query Parameters

​
metric_from
string<date>
required

Start date for metrics (inclusive)

​
metric_to
string<date>
required

End date for metrics (inclusive)

​
tag
string
required

Filter by tag

​
cursor
string | null

Cursor for pagination

​
page
integer | null

Page number for offset-based pagination (only used if cursor is not provided)

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

Number of items per page

Required range: 1 <= x <= 100

Response

Successfully retrieved monthly address metrics

  • PaginatedAddressesMetricsMonthly
  • CursorPaginatedAddressesMetricsMonthly

Schema for Address Metrics in list response.

​
items
AddressesMetricsMonthlyRead · 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.

​
pagination_type
string
default:offset
Allowed value: "offset"