PRpredicthq
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

Request

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.

Changes

No recorded changes to this operation across all 1 revision of this API.