Search Events for a Saved Location

Search for events happening in an existing Saved Location.

Request
HTTP Request
GET https://api.predicthq.com/v1/saved-locations/$location_id/insights/events
Path Parameters
Parameter
Description
location_id
An existing Saved Location ID.
Query Parameters
Parameter
Description
date_range_type
string
Date range to fetch events for.

Currently the only supported date ranges are:
next_90d
E.g. ?date_range_type=next_90d
category
string
Comma-separated list of event categories to include.

Please refer to the category parameter in Events API.

E.g. ?category=sports,concerts
sort
string
Sort order for results.

Please refer to the sort parameter in Events API.

E.g. ?sort=phq_attendance
limit
number
The maximum number of results to return. The default limit is 10.

E.g. ?limit=10
offset
number
The number of results to skip. The default is 0.

E.g. ?offset=20
Response
Response Fields
Field
Description
count
number
Total number of results found.
results
array
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.
Example response
Below is an example response:
{
  "count": 522,
  "results": [
    {
      "id": "8uPpWYtuLFKmdswgXL",
      "title": "Folsom Street Fair",
      "description": "The mission of Folsom Street Events is to create world-class leather and fetish events that unite the adult alternative lifestyle communities with safe venues for self-expression and exciting entertainment.",
      "entities": [
        {
          "formatted_address": "",
          "type": "event-group",
          "name": "Folsom Street Fair"
        }
      ],
      "place_hierarchies": [
        [
          "6295630",
          "6255149",
          "6252001",
          "5332921",
          "5391997",
          "5391959"
        ]
      ],
      "timezone": "America/Los_Angeles",
      "location": [
        -122.39231700000002,
        37.789024100000006
      ],
      "start": "2023-09-24T07:00:00Z",
      "end": "2023-09-25T06:59:59Z",
      "duration": 86399,
      "category": "festivals",
      "labels": [
        "entertainment",
        "festival"
      ],
      "phq_attendance": 400000,
      "rank": 100,
      "local_rank": 100,
      "geo": {
        "geometry": {
          "type": "Polygon",
          "coordinates": [
            [
              [
                -122.39120568030553,
                37.7903973041606
              ],
              [
                -122.39089017614494,
                37.79064318446613
              ],
              [
                -122.39039841553388,
                37.790012176144934
              ],
              [
                -122.39342831969448,
                37.787650895839406
              ],
              [
                -122.39374382385508,
                37.78740501553388
              ],
              [
                -122.39423558446613,
                37.78803602385507
              ],
              [
                -122.39120568030553,
                37.7903973041606
              ]
            ]
          ]
        }
      },
      "state": "active",
      "predicted_event_spend": 51223933,
      "predicted_event_spend_industries": {
        "accommodation": 24096533,
        "hospitality": 20882800,
        "transportation": 6244600
      }
    },
    {
      "id": "6VSWpModQLPewdbDx2",
      "title": "Dreamforce",
      "description": "Dreamforce gathers the entire Salesforce community — our customers, partners, employees, and key stakeholders — for a fun family reunion.",
      "entities": [
        {
          "formatted_address": "800 Howard Street\nSan Francisco, CA 94103\nUnited States of America",
          "type": "venue",
          "name": "Moscone Center - West"
        },
        {
          "formatted_address": "",
          "type": "event-group",
          "name": "Dreamforce"
        }
      ],
      "place_hierarchies": [
        [
          "6295630",
          "6255149",
          "6252001",
          "5332921",
          "5391997",
          "5391959"
        ]
      ],
      "timezone": "America/Los_Angeles",
      "location": [
        -122.403445,
        37.783197
      ],
      "start": "2023-09-12T17:00:00Z",
      "end": "2023-09-15T01:00:00Z",
      "duration": 201600,
      "category": "conferences",
      "labels": [
        "business",
        "conference",
        "sales",
        "technology"
      ],
      "phq_attendance": 170000,
      "rank": 95,
      "local_rank": 100,
      "geo": {
        "geometry": {
          "type": "Point",
          "coordinates": [
            -122.403445,
            37.783197
          ]
        },
        "placekey": "222@5vg-7gv-3t9"
      },
      "state": "active",
      "predicted_event_spend": 163214070,
      "predicted_event_spend_industries": {
        "accommodation": 112651293,
        "hospitality": 42600912,
        "transportation": 7961865
      }
    },
    ...
  ]
}
Examples
curl
python
curl --location 'https://api.predicthq.com/v1/saved-locations/0b6ZrOnTdB2Y7k4zC_9qBg/insights/events?date_range_type=next_90d&category=public-holidays%2Csports&sort=start' \
--header 'Authorization: Bearer TOKEN'
import requests
​
url = "https://api.predicthq.com/v1/saved-locations/0b6ZrOnTdB2Y7k4zC_9qBg/insights/events?date_range_type=next_90d&category=public-holidays,sports&sort=start"
​
payload={}
headers = {
  'Authorization': 'Bearer TOKEN'
}
​
response = requests.request("GET", url, headers=headers, data=payload)
​
print(response.text)
Guides
Below are some guides relevant to this API:
​Working with Location-Based Subscriptions​

Parameter	Description
`location_id`	An existing Saved Location ID.

Parameter	Description
`date_range_type` string	Date range to fetch events for. Currently the only supported date ranges are: `next_90d` E.g. `?date_range_type=next_90d`
`category` string	Comma-separated list of event categories to include. Please refer to the `category` parameter in Events API. E.g. `?category=sports,concerts`
`sort` string	Sort order for results. Please refer to the `sort` parameter in Events API. E.g. `?sort=phq_attendance`
`limit` number	The maximum number of results to return. The default limit is `10`. E.g. `?limit=10`
`offset` number	The number of results to skip. The default is `0`. E.g. `?offset=20`

Field	Description
`count` number	Total number of results found.
`results` array	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.

Get a Saved Location

Update a Saved Location

Last modified 2mo ago