Sign in

v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB
Saved Locations API

Search Events for a Saved Location

Returns events that impact the specified Saved Location. Please refer to the Events API docs for the available query parameters in addition to those listed below.

get/v1/saved-locations/{location_id}/insights/events

Path parameters

location_idstring required

An existing Saved Location ID.

Query parameters

date_range_type'next_90d'

The type of date range for insight calculations. Currently only next_90d is supported.

Date range to fetch events for.

Currently the only supported date ranges are:

  • next_90d
offsetinteger

Zero-based index of the first result to return.

limitinteger

Maximum number of results to return per page.

Response

Successful Response

countinteger required

Total number of results found.

resultsobject[] required

List of results where each item is an Event.

Please refer to the response fields section in Search Events for the structure of each record.