Skip to main content
GET
/
contractors
/
{id}
/
metrics
Get Filtered Metrics By Contractor Id
curl --request GET \
  --url https://api.shovels.ai/v2/contractors/{id}/metrics \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "property_type": "residential",
      "date": "2022-01-01",
      "tag": "solar",
      "permit_count": 10,
      "avg_job_value": 1000000,
      "total_job_value": 10000000,
      "avg_construction_duration": 100,
      "avg_inspection_pass_rate": 95
    },
    {
      "property_type": "residential",
      "date": "2022-02-01",
      "tag": "solar",
      "permit_count": 4,
      "avg_job_value": 1000000,
      "total_job_value": 10000000,
      "avg_construction_duration": 30,
      "avg_inspection_pass_rate": 45
    }
  ],
  "size": 2,
  "next_cursor": "eyJkYXRlIjoi"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

Filter by the specified contractor ID.

Query Parameters

​
metric_from
string<date>
required

Start date for metrics (inclusive)

​
metric_to
string<date>
required

End date for metrics (inclusive)

​
property_type
string
required

Filter by property type

​
tag
string
required

Filter by tag

​
cursor
string | null

Cursor for pagination

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

Response

Contractor monthly metrics

Schema for cursor-paginated contractors metrics response.

​
items
ContractorsMetricsMonthlyRead · object[]
required

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

​
size
integer
required

The number of items returned in the response.

​
next_cursor
string | null
required

The cursor for retrieving the next page of results.

​
total_count
TotalCount · object

Total result count (capped at 10,000). Present on first-page responses when include_count=true. null if the count query timed out.