Search Saved Locations

Search for an existing Saved Location.

Request

HTTP Request

GET https://api.predicthq.com/v1/saved-locations

Query Parameters

Response

Response Fields

Example response

Below is an example response:

{
  "count": 1,
  "locations": [
    {
      "location_id": "h8LbiiiTOXsxSAI0p3wEIg",
      "create_dt": "2023-03-27T22:07:00+00:00",
      "update_dt": "2023-07-03T04:31:38+00:00",
      "enrich_dt": "2023-07-03T04:31:39+00:00",
      "insights_dt": "2023-07-03T04:31:40+00:00",
      "name": "My Parking Building",
      "labels": [
          "parking"
      ],
      "geojson": {
          "type": "Feature",
          "properties": {
              "radius": 0.9,
              "radius_unit": "mi"
          },
          "geometry": {
              "type": "Point",
              "coordinates": [
                  -122.40152,
                  37.7869
              ]
          }
      },
      "formatted_address": "666 Mission St, San Francisco, CA 94105, USA",
      "places": [
          {
              "place_id": 5391959,
              "type": "locality",
              "name": "San Francisco",
              "county": "City and County of San Francisco",
              "region": "California",
              "country": "US",
              "geojson": {
                  "type": "Feature",
                  "geometry": {
                      "type": "Point",
                      "coordinates": [
                          -122.41942,
                          37.77493
                      ]
                  }
              }
          }
      ],
      "summary_insights": [
          {
              "date_range": {
                  "type": "next_90d",
                  "start_dt": "2023-07-03T04:31:40+00:00",
                  "end_dt": "2023-10-01T04:31:40+00:00"
              },
              "phq_attendance_sum": 2646606,
              "attended_event_count": 519,
              "non_attended_event_count": 85,
              "unscheduled_event_count": 0
          }
      ],
      "subscription_valid_types": [
          "events"
      ],
      "status": "active"
    }
  ]
}

Examples

curl --location 'https://api.predicthq.com/v1/saved-locations?q=alabama&limit=50' \
--header 'Authorization: Bearer TOKEN'

Guides

Below are some guides relevant to this API:

Last updated

© 2024 PredictHQ Ltd