v1

OpenAPI 3.1.02026-07-133254206.1 KB
Contractors
Contractors
Contractors

Get Filtered Metrics By Contractor Id

Returns contractor monthly metrics filtered by contractor ID, property type, and tags. Metrics include permit count, average duration, and average pass rate.

get/contractors/{id}/metrics

Path parameters

idstring required

Filter by the specified contractor ID.

Filter by the specified contractor ID.

Query parameters

metric_fromstring date required

Start date for metrics (inclusive)

Start date for metrics (inclusive)

metric_tostring date required

End date for metrics (inclusive)

End date for metrics (inclusive)

property_typestring required

Filter by property type

Filter by property type

tagstring required

Filter by tag

Filter by tag

cursorstring nullable

Cursor for pagination

Cursor for pagination

sizeinteger

Response

Contractor monthly metrics

sizeinteger required

The number of items returned in the response.

next_cursorstring nullable required

The cursor for retrieving the next page of results.