SHshovels
Cities

Get City Metrics Monthly

Changed on

Returns monthly city metrics.

get/cities/{geo_id}/metrics/monthly

Request

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

Path parameters

geo_idstring required

Filter by the specified city 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 required

Filter by tag

cursorstring nullable

Cursor for pagination

sizeinteger

Response

Monthly metrics for the city

sizeinteger required

The number of items returned in the response.

next_cursorstring nullable required

The cursor for retrieving the next page of results.

Changes