Skip to main content
GET
Get Filtered Metrics By Contractor Id

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
default:all

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.

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 | null

Top-level count object, not an integer: {"value": 970, "relation": "eq"}. "eq" means an exact count up to 10,000. "gte" means at least 10,000 matches, with value set to 10,000. Counted only when requested on the first page without a cursor. null when not requested, on later pages, or when the count query times out.

Example: