Search Saved Locations
Search for an existing Saved Location.
Request
HTTP Request
Query Parameters
Field | Description |
---|---|
| A comma-separated string consisting of a list of 1 or more location_id's.
E.g. |
| A full-text search query that searches across the following fields:
E.g. |
| A comma-separated list of fields to sort results by. Use the Possible values:
You can also sort by the summary insight values. Summary insights are calculated for different date ranges (currently only the next 90 days have been implemented) and you need to choose which date range to sort by. Use the format below to sort by summary insights: For example, below are the sort options for the summary insights calculated for the next 90d:
You can prefix these with a minus sign
E.g.: |
| The maximum number of results to return. The default limit is 10.
E.g. |
| Used for paging. The number of results to skip. The default is 0.
E.g. |
Response
Response Fields
Field | Description |
---|---|
| Total number of results found. |
| List of results where each item is a Saved Location. Please refer to the response fields section in Get a Saved Location for the structure of each record. |
Examples
Guides
Below are some guides relevant to this API:
Last updated