SHshovels
Addresses

Get Address Metrics Monthly

Changed on

Returns monthly address metrics.

get/addresses/{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 geolocation ID.

Query parameters

metric_fromstring date required

Start date for metrics (inclusive)

metric_tostring date required

End date for metrics (inclusive)

tagstring required

Filter by tag

cursorstring nullable

Cursor for pagination

sizeinteger

Response

Successfully retrieved monthly address 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

  • 64df4c8074f5Revision changes
    • breaking

      for the query request parameter size, default value was changed from 50 to 10

  • 685b8866c451Revision changes
    • info

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

    • info

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