SHshovels
Contractors
Contractors
Contractors

Get Filtered Metrics By Contractor Id

Changed on

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

Request

  • Base URL
    https://api.shovels.ai/v2
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Filter by the specified contractor ID.

Query parameters

metric_fromstring date required

Start date for metrics (inclusive)

metric_tostring date required

End date for metrics (inclusive)

property_typestring required

Filter by property type

tagstring

Filter metrics by one tag. Omit this parameter or use all for aggregate metrics without filtering by tag. Date and property type filters still apply.

cursorstring nullable

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.

Changes

  • e9f48948b723Revision changes
    • info

      the query request parameter tag became optional

  • 685b8866c451Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status