{"version":1,"pages":[{"id":"7v7Nv8PRKH2d2AY80S6e","title":"Overview","pathname":"/","siteSpaceId":"sitesp_BV6eG","description":"Docs, guides, and API references to help you build with PredictHQ.","breadcrumbs":[{"label":"Tech Docs"}]},{"id":"R07MzFUaZmd4IUwvzErG","title":"How to use PredictHQ","pathname":"/how-to-use-predicthq","siteSpaceId":"sitesp_BV6eG","description":"The recommended integration paths for PredictHQ: train forecasting models on event features, ground AI systems in verified real-world context, or get event-driven forecasts without building a model.","breadcrumbs":[{"label":"Tech Docs"}]},{"id":"DsKDAetowkuExiU7GNln","title":"API quickstart","pathname":"/getting-started/api-quickstart","siteSpaceId":"sitesp_BV6eG","description":"Get your API key, make your first call, and understand how PredictHQ fits into a production integration.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"6RQwRUeOAZtb1cy4R6Bu","title":"Tutorials","pathname":"/getting-started/tutorials","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"7A5YkeISsjkvCWnTyl5U","title":"Measure the forecast lift on sample data","pathname":"/getting-started/tutorials/measure-the-forecast-lift","siteSpaceId":"sitesp_BV6eG","description":"Build the recommended PredictHQ integration on sample demand data - Saved Location, Beam, model-ready features - and finish with a measured forecast accuracy improvement you produced yourself.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Tutorials"}]},{"id":"NVHl9y4jbheeoUJwARQ6","title":"Core concepts","pathname":"/getting-started/core-concepts","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"Nzsiy0oM388dcNFdeKrJ","title":"Event-driven demand","pathname":"/getting-started/core-concepts/event-driven-demand","siteSpaceId":"sitesp_BV6eG","description":"Using real-world events to improve forecasting and operational decisions introduces structural challenges around scope, relevance, usability, and trust.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Core concepts"}]},{"id":"HIZmJAkQV3Rq3GyKxz3P","title":"What is Beam?","pathname":"/getting-started/core-concepts/what-is-beam","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Core concepts"}]},{"id":"cihKW5lJQXWebxkQ53aM","title":"What is the Features API?","pathname":"/getting-started/core-concepts/what-is-the-features-api","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Core concepts"}]},{"id":"pgzNEtZfcCRAP97i4lz2","title":"Which API should I use?","pathname":"/getting-started/core-concepts/which-api-should-i-use","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Core concepts"}]},{"id":"hx8abvxDyHq09DeCMwIj","title":"Data leakage in backtesting: why it doesn't affect forecast accuracy","pathname":"/getting-started/core-concepts/data-leakage-in-backtesting","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Core concepts"}]},{"id":"HsPPsHOkP7MR2kzrGui3","title":"Guide to protecting PredictHQ data","pathname":"/getting-started/core-concepts/guide-to-protecting-predicthq-data","siteSpaceId":"sitesp_BV6eG","description":"It's important to protect PredictHQ data from unauthorized access and usage.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Core concepts"}]},{"id":"st89kYmytriw2o6zUJrT","title":"Glossary","pathname":"/getting-started/glossary","siteSpaceId":"sitesp_BV6eG","description":"Definitions of key terms used across PredictHQ’s platform and APIs. Use as a reference.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"A4LF92G90QHweLm7SD8N","title":"Data science notebooks","pathname":"/getting-started/data-science-notebooks","siteSpaceId":"sitesp_BV6eG","description":"Jupyter notebooks for training and improving demand forecasting models with PredictHQ event features—Beam calibration, model-ready features, and worked forecasting examples.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"2TvEkHILoEA2PsGxqs6t","title":"PredictHQ data","pathname":"/getting-started/predicthq-data","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"NMsvgF8aK2ESSZp6aPBE","title":"Data accuracy","pathname":"/getting-started/predicthq-data/data-accuracy","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"MfuXj1el5wCFUbozew6z","title":"Event categories","pathname":"/getting-started/predicthq-data/event-categories","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"WFED4UUxTtSKsn6qYcuO","title":"Attendance-based events","pathname":"/getting-started/predicthq-data/event-categories/attendance-based-events","siteSpaceId":"sitesp_BV6eG","description":"Attended Events are gatherings with a start and end date/time, where people come together in one location for entertainment or business.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"},{"label":"Event categories"}]},{"id":"xZ4DhqIhnetBwz56rH90","title":"Non-Attendance-based events","pathname":"/getting-started/predicthq-data/event-categories/non-attendance-based-events","siteSpaceId":"sitesp_BV6eG","description":"Non-Attendance-Based Events are events with a start and end date, but are more fluid and distributed in impact, such as observances or school holidays.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"},{"label":"Event categories"}]},{"id":"uoUuuQylOYpxMsz76xAM","title":"Unscheduled events","pathname":"/getting-started/predicthq-data/event-categories/unscheduled-events","siteSpaceId":"sitesp_BV6eG","description":"Live coverage of breaking events such as severe weather and terrorism. The API updates minute to minute to ensure accuracy.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"},{"label":"Event categories"}]},{"id":"EqQlerCDu8rVAW0Qe0Ce","title":"Live TV events","pathname":"/getting-started/predicthq-data/event-categories/live-tv-events","siteSpaceId":"sitesp_BV6eG","description":"Live TV Events covers live broadcast sports games with a large number of people watching at a particular time across different counties across the United States.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"},{"label":"Event categories"}]},{"id":"gwPU9bST8lZjJWcnhVXT","title":"Labels","pathname":"/getting-started/predicthq-data/labels","siteSpaceId":"sitesp_BV6eG","description":"Event labels are succinct descriptive attributes attached to events that can help with granular data selection and feature engineering use cases.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"6icmmjeoImglvVu4EHxJ","title":"Entities","pathname":"/getting-started/predicthq-data/entities","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"KJv0rFFhSzQ0xgbQpOWR","title":"Ranks","pathname":"/getting-started/predicthq-data/ranks","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"5tG69958MnrRKolo9c0r","title":"PHQ Rank","pathname":"/getting-started/predicthq-data/ranks/phq-rank","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"},{"label":"Ranks"}]},{"id":"EOAA5gG9hBYT7jbz2miW","title":"Local Rank","pathname":"/getting-started/predicthq-data/ranks/local-rank","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"},{"label":"Ranks"}]},{"id":"x4UJe6tmZsDpJRKeFUN5","title":"Predicted Attendance","pathname":"/getting-started/predicthq-data/predicted-attendance","siteSpaceId":"sitesp_BV6eG","description":"Predicted Attendance represents the number of people predicted to attend an event.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"adnTe9w9bksEH0VFYW7c","title":"Predicted End Times","pathname":"/getting-started/predicthq-data/predicted-end-times","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"rSs5Ugunx69MjR90nacC","title":"Predicted Event Spend","pathname":"/getting-started/predicthq-data/predicted-event-spend","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"c5r2GVZotm46psC1ueSV","title":"Predicted Events","pathname":"/getting-started/predicthq-data/predicted-events","siteSpaceId":"sitesp_BV6eG","description":"Get insight into events as early as possible, to assess whether they would have an impact on your business.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"VdixFQBb772N7ecV2gc8","title":"Predicted Impact Patterns","pathname":"/getting-started/predicthq-data/impact-patterns","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"PredictHQ data"}]},{"id":"Xuzxdsl1ogbQ5wzu3yR5","title":"Guides","pathname":"/getting-started/guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"LkCgBP0ljobrRZsbcOyB","title":"Geolocation guides","pathname":"/getting-started/guides/geolocation-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"DA8F5AeWRpDBKnuJt7Uc","title":"Overview","pathname":"/getting-started/guides/geolocation-guides/overview","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"}]},{"id":"3SV5KlJat48lDgIBoaBm","title":"Searching by location","pathname":"/getting-started/guides/geolocation-guides/searching-by-location","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"}]},{"id":"c1kII7e5GbIbyZzNyBi8","title":"Find events by latitude/longitude and radius","pathname":"/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-latitude-longitude-and-radius","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"},{"label":"Searching by location"}]},{"id":"qSZ3cPjaaIeYM1wzVSh7","title":"Find events by place ID","pathname":"/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-place-id","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"},{"label":"Searching by location"}]},{"id":"0n2LMXE4JT9iluZQ4SIj","title":"Find events by IATA code","pathname":"/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-iata-code","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"},{"label":"Searching by location"}]},{"id":"ECIHjcEuxyRFsXqNTOiv","title":"Find events by country code","pathname":"/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-country-code","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"},{"label":"Searching by location"}]},{"id":"wVZh9cffZUG2ntfhScIQ","title":"Find events by Placekey","pathname":"/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-placekey","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"},{"label":"Searching by location"}]},{"id":"onTzS6b4n2WT5T5rRKjA","title":"Working with location-based subscriptions","pathname":"/getting-started/guides/geolocation-guides/searching-by-location/working-with-location-based-subscriptions","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"},{"label":"Searching by location"}]},{"id":"jd2fXpQswkjfd7qOvbid","title":"Understanding place hierarchies","pathname":"/getting-started/guides/geolocation-guides/understanding-place-hierarchies","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"}]},{"id":"1fiqwUqiX2m4n4ZkDfHJ","title":"Working with polygons","pathname":"/getting-started/guides/geolocation-guides/working-with-polygons","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"}]},{"id":"m2o67fcx9I8ofvCTjzum","title":"Join events using Placekey","pathname":"/getting-started/guides/geolocation-guides/join-events-using-placekey","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Geolocation guides"}]},{"id":"5UlfHmzYF1FdrX4KNkF2","title":"Date and time guides","pathname":"/getting-started/guides/date-and-time-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"fRdAfvH37siL58mArPsp","title":"Working with recurring events","pathname":"/getting-started/guides/date-and-time-guides/working-with-recurring-events","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Date and time guides"}]},{"id":"IqbwLYODhC0Om1jsIPbK","title":"Working with multi-day and umbrella events","pathname":"/getting-started/guides/date-and-time-guides/working-with-multi-day-and-umbrella-events","siteSpaceId":"sitesp_BV6eG","description":"How to interpret phq_attendance for multi-day events and avoid double-counting umbrella events when working with individual event records.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Date and time guides"}]},{"id":"dbidYJCruWJG2UKya3kw","title":"Working with dates, times and timezones","pathname":"/getting-started/guides/date-and-time-guides/working-with-dates-times-and-timezones","siteSpaceId":"sitesp_BV6eG","description":"Working with dates, times and timezones can be hard.This guide aims to clarify how to work with these with PredictHQ data.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Date and time guides"}]},{"id":"ZrHrB8l8bwSec5MLR87f","title":"Events API guides","pathname":"/getting-started/guides/events-api-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"RPpp9hzaFXKf8e0McsXG","title":"Filtering and finding relevant events","pathname":"/getting-started/guides/events-api-guides/filtering-and-finding-relevant-events","siteSpaceId":"sitesp_BV6eG","description":"Learn how to filter and find events relevant to your business using PredictHQ's Events API.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Events API guides"}]},{"id":"jKyyavojJgm3qskeYxb6","title":"Displaying events in a heatmap calendar","pathname":"/getting-started/guides/events-api-guides/displaying-events-in-a-heatmap-calendar","siteSpaceId":"sitesp_BV6eG","description":"Learn how to create a heatmap-styled calendar to display event attendance for a location.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Events API guides"}]},{"id":"F2nKjEaFPaQee8ayWVo8","title":"Displaying events on a map","pathname":"/getting-started/guides/events-api-guides/displaying-events-on-a-map","siteSpaceId":"sitesp_BV6eG","description":"Learn how to display events on a map for a specific location.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Events API guides"}]},{"id":"F0uTrsjdM51wI3VTHMZG","title":"Features API guides","pathname":"/getting-started/guides/features-api-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"aeCTGsb2VLn7rbry7HnJ","title":"Improving demand forecasting models with event features","pathname":"/getting-started/guides/features-api-guides/improving-demand-forecasting-models-with-event-features","siteSpaceId":"sitesp_BV6eG","description":"Learn how to integrate PredictHQ's event features into your demand forecasting model.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Features API guides"}]},{"id":"X3twxMkUt19YjJXAxSp3","title":"Forecasting demand in Power BI with event features","pathname":"/getting-started/guides/features-api-guides/integrate-with-a-demand-forecast-in-powerbi","siteSpaceId":"sitesp_BV6eG","description":"Use PowerBI's AutoML models to forecast demand using PredictHQ technologies.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Features API guides"}]},{"id":"VdRGB1wyALApXMy4uZi4","title":"Using event features with time series foundation models","pathname":"/getting-started/guides/features-api-guides/using-event-features-with-time-series-foundation-models","siteSpaceId":"sitesp_BV6eG","description":"Supply PredictHQ event features as future covariates to pre-trained forecasting models such as Chronos, TimesFM, and TimeGPT.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Features API guides"}]},{"id":"rVsoGBB4jypg8Qidsum3","title":"Forecasts API guides","pathname":"/getting-started/guides/forecasts-api-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"SAWHvFxQ42lIiXzTkvbW","title":"Getting started with Forecasts API","pathname":"/getting-started/guides/forecasts-api-guides/getting-started","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Forecasts API guides"}]},{"id":"SvTi40NSVZpAL4XTwx29","title":"Understanding forecast accuracy metrics","pathname":"/getting-started/guides/forecasts-api-guides/understanding-forecast-accuracy-metrics","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Forecasts API guides"}]},{"id":"vNokITp0358OIRKh4M0e","title":"Troubleshooting guide for Forecasts API","pathname":"/getting-started/guides/forecasts-api-guides/troubleshooting","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Forecasts API guides"}]},{"id":"UKz8djQp6vBnww15gzN9","title":"Live TV event guides","pathname":"/getting-started/guides/live-tv-event-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"A79GuCxUPkkmbm9CF8CD","title":"Find Broadcasts by county place ID","pathname":"/getting-started/guides/live-tv-event-guides/find-broadcasts-by-county-place-id","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Live TV event guides"}]},{"id":"EeKdbTSN1QL9taKzo7m8","title":"Find Broadcasts by latitude and longitude","pathname":"/getting-started/guides/live-tv-event-guides/find-broadcasts-by-latitude-and-longitude","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Live TV event guides"}]},{"id":"GNJs8UtDJLbdd5zsHBb5","title":"Find all Broadcasts for an event","pathname":"/getting-started/guides/live-tv-event-guides/find-all-broadcasts-for-an-event","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Live TV event guides"}]},{"id":"Lc02DRQm8ygNg8qKiKJR","title":"Find Broadcasts for specific sport types","pathname":"/getting-started/guides/live-tv-event-guides/find-broadcasts-for-specific-sport-types","siteSpaceId":"sitesp_BV6eG","description":"Better understand predicted vs scheduled broadcasts as well as different sport types.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Live TV event guides"}]},{"id":"B4lBYboLGgEDQ1rwa6mm","title":"Aggregating live TV events","pathname":"/getting-started/guides/live-tv-event-guides/aggregating-live-tv-events","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Live TV event guides"}]},{"id":"Gue0Nq6lLgbIaWCATKRw","title":"Beam guides","pathname":"/getting-started/guides/beam-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"1xNUuZquUHtBAwkzb1Bq","title":"Understanding demand variability and event contribution in Beam","pathname":"/getting-started/guides/beam-guides/understanding-demand-variability-and-event-contribution-in-beam","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Beam guides"}]},{"id":"YkdHvt9ourQFyvLhD8wg","title":"Sample demand data","pathname":"/getting-started/guides/beam-guides/sample-demand-data","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"},{"label":"Beam guides"}]},{"id":"3p9d5VaYGRHcuzGsG59I","title":"Streamlit demo apps","pathname":"/getting-started/guides/streamlit-demo-apps","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"TyP414JO8wKfZfQgQrkr","title":"Industry recommendations","pathname":"/getting-started/guides/industry-specific-event-filters","siteSpaceId":"sitesp_BV6eG","description":"How PredictHQ tailors results to your industry, the named industry values, and industry-level default categories and rank thresholds for when Beam can't be used.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Guides"}]},{"id":"bS5wEn0omefpQsP8yc90","title":"Use case guides","pathname":"/getting-started/use-case-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"}]},{"id":"9crAa5HQQzO4BvEYPSoj","title":"Accommodation: the proven path to value","pathname":"/getting-started/use-case-guides/accommodation-the-proven-path-to-value","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Getting started"},{"label":"Use case guides"}]},{"id":"b7j37e843pfp6eitvqtJ","title":"Build with AI","pathname":"/ai/build-with-ai","siteSpaceId":"sitesp_BV6eG","description":"Ground AI systems in verified real-world event data and build integrations faster with the MCP server, agent skills, and AI-readable docs.","breadcrumbs":[{"label":"Tech Docs"},{"label":"AI & agents"}]},{"id":"n0mvVPel9fDOO6M45o9U","title":"Grounding LLMs in real-world event data","pathname":"/ai/grounding-llms-in-real-world-data","siteSpaceId":"sitesp_BV6eG","description":"What grounding is, how RAG relates to it, how grounding reduces AI hallucinations, and how to ground LLMs and agents in verified real-world event data - in your environment or on demand via MCP.","breadcrumbs":[{"label":"Tech Docs"},{"label":"AI & agents"}]},{"id":"u3WWyLMoBpFfT9zwuy6x","title":"MCP server","pathname":"/ai/mcp","siteSpaceId":"sitesp_BV6eG","description":"Connect AI agents to verified real-world event context on demand. External grounding for LLMs via the Model Context Protocol—no data pipeline to maintain.","breadcrumbs":[{"label":"Tech Docs"},{"label":"AI & agents"}]},{"id":"p2feiTWWTn2Py2MivfPn","title":"PredictHQ MCP in agentic workflows","pathname":"/ai/predicthq-mcp-in-agentic-workflows","siteSpaceId":"sitesp_BV6eG","description":"Reference architectures for autonomous agents that query the PredictHQ MCP server for verified demand context at decision time.","breadcrumbs":[{"label":"Tech Docs"},{"label":"AI & agents"}]},{"id":"02sy9IDJpWYhH5ThHnX0","title":"Agent skills","pathname":"/ai/agent-skills","siteSpaceId":"sitesp_BV6eG","description":"Install PredictHQ agent skills to give AI coding assistants best-practice integration knowledge - recommended workflow, API selection, and Beam guidance, applied automatically while you build.","breadcrumbs":[{"label":"Tech Docs"},{"label":"AI & agents"}]},{"id":"aQNnmNR0ZV0DFv6hC1GV","title":"Bolt","pathname":"/ai/bolt","siteSpaceId":"sitesp_BV6eG","description":"An AI-native notebook inside the PredictHQ WebApp. Bolt answers from live PredictHQ API data—a working example of a grounded agent.","breadcrumbs":[{"label":"Tech Docs"},{"label":"AI & agents"}]},{"id":"dYpMygHmthIQdLs2Qsad","title":"Integration guides","pathname":"/integrations/integration-guides","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"}]},{"id":"XxSHmYg1kXkXufPV14kO","title":"Standard integration pattern","pathname":"/integrations/integration-guides/standard-integration-pattern","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Integration guides"}]},{"id":"Ifz5t8pHf3ykTw1rQIVv","title":"Internal grounding: retrieval inside your environment","pathname":"/integrations/integration-guides/internal-grounding","siteSpaceId":"sitesp_BV6eG","description":"Reference architecture for internal grounding: retrieving verified PredictHQ event context inside your own environment at answer time, so your AI systems respond from facts they can cite.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Integration guides"}]},{"id":"ISm3Ky4V5LBYApR1fuMO","title":"Keep data updated via API","pathname":"/integrations/integration-guides/keep-data-updated-via-api","siteSpaceId":"sitesp_BV6eG","description":"Event information changes frequently. For example, a date changes, an event gets cancelled or ranking is updated. It’s important to keep your data set up to date.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Integration guides"}]},{"id":"Vfy8bnV3GIqgbVFstKL3","title":"Loading event data into a data warehouse","pathname":"/integrations/integration-guides/loading-event-data-into-a-data-warehouse","siteSpaceId":"sitesp_BV6eG","description":"Take PredictHQ API data and load it into a data warehouse, in this example, GCP BigQuery.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Integration guides"}]},{"id":"yZenbIm689TezPsPlYUI","title":"Integrate with Loop Links","pathname":"/integrations/integration-guides/integrate-with-loop-links","siteSpaceId":"sitesp_BV6eG","description":"Loop Links provide an easy way for you submit missing Events and provide feedback on existing Events.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Integration guides"}]},{"id":"qdSc8rA5nWi1VBeyqJ3K","title":"Third-party integrations","pathname":"/integrations/third-party-integrations","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"}]},{"id":"X4mYolu28XeEIKMyGcAN","title":"Receive data via Snowflake","pathname":"/integrations/third-party-integrations/snowflake","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"}]},{"id":"md9GmBTddRDCEnd55lRk","title":"Example SQL queries for Snowflake","pathname":"/integrations/third-party-integrations/snowflake/example-sql-queries-for-snowflake","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"},{"label":"Receive data via Snowflake"}]},{"id":"tyEKg5P71AQ9vlH3cdPv","title":"Snowflake data science guide","pathname":"/integrations/third-party-integrations/snowflake/snowflake-data-science-guide","siteSpaceId":"sitesp_BV6eG","description":"Transforming Event Data into ML-Ready Features in Snowflake","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"},{"label":"Receive data via Snowflake"}]},{"id":"Y1VIYsgakokVf627e0Rn","title":"Snowpark method guide","pathname":"/integrations/third-party-integrations/snowflake/snowflake-data-science-guide/snowpark-method-guide","siteSpaceId":"sitesp_BV6eG","description":"Transforming Event Data into ML-Ready Features using Snowpark and Python","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"},{"label":"Receive data via Snowflake"},{"label":"Snowflake data science guide"}]},{"id":"GjEFU60uNZc4QSpPKLd4","title":"SQL method guide","pathname":"/integrations/third-party-integrations/snowflake/snowflake-data-science-guide/sql-method-guide","siteSpaceId":"sitesp_BV6eG","description":"Transforming Event Data into ML-Ready Features using SQL","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"},{"label":"Receive data via Snowflake"},{"label":"Snowflake data science guide"}]},{"id":"7MXRpLN66w6w1wIYPTHx","title":"Receive data via AWS Data Exchange","pathname":"/integrations/third-party-integrations/aws-data-exchange","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"}]},{"id":"Zlzau43dfa0a8MJ9WIID","title":"CSV/Parquet data structure for ADX","pathname":"/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx","siteSpaceId":"sitesp_BV6eG","description":"Data can be provided as NDJSON, CSV or Parquet. This document describes the CSV/Parquet data structure.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"},{"label":"Receive data via AWS Data Exchange"}]},{"id":"dIAI8JnPvdjn0ZstFRHO","title":"NDJSON data structure for ADX","pathname":"/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx","siteSpaceId":"sitesp_BV6eG","description":"Data can be provided as NDJSON, CSV or Parquet. This document describes the NDJSON data structure.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"},{"label":"Receive data via AWS Data Exchange"}]},{"id":"iN1q4ULMt36SqD1oohJi","title":"Receive data via SFTP","pathname":"/integrations/third-party-integrations/sftp","siteSpaceId":"sitesp_BV6eG","description":"","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"}]},{"id":"j8yD4yS23fsHMUfLtHnp","title":"Integrate with Databricks","pathname":"/integrations/third-party-integrations/integrate-with-databricks","siteSpaceId":"sitesp_BV6eG","description":"Deploy PredictHQ's verified real-world context into Databricks via S3 or Snowflake for model training, inference-time features, and grounding AI systems.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"}]},{"id":"jjEA75JGDOCSXOCYnp74","title":"Using event data in Tableau","pathname":"/integrations/third-party-integrations/using-event-data-in-tableau","siteSpaceId":"sitesp_BV6eG","description":"Learn how to connect PredictHQ data to Tableau and build an example dashboard.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"}]},{"id":"Gg498YTnzRhcDlQtNUkH","title":"Using event data in Power BI","pathname":"/integrations/third-party-integrations/using-event-data-in-power-bi","siteSpaceId":"sitesp_BV6eG","description":"Learn how to connect PredictHQ data to Power BI using multiple methods, and build an example report.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"}]},{"id":"7Ogcea3Anr1khNSkYgSe","title":"Connecting to PredictHQ APIs with Microsoft Excel","pathname":"/integrations/third-party-integrations/connecting-to-predicthq-apis-with-microsoft-excel","siteSpaceId":"sitesp_BV6eG","description":"Learn how to connect PredictHQ data to Microsoft Excel using APIs.","breadcrumbs":[{"label":"Tech Docs"},{"label":"Integrations"},{"label":"Third-party integrations"}]},{"id":"SOg7tajOqaMvcGGaPmWW","title":"Python SDK","pathname":"/sdks/python-sdk","siteSpaceId":"sitesp_BV6eG","description":"The official PredictHQ Python Client provides a consistent, pythonic interface to our API.","breadcrumbs":[{"label":"Tech Docs"},{"label":"PredictHQ SDKs"}]},{"id":"8qHJRWr1oGG7h6SImtxI","title":"JavaScript SDK","pathname":"/sdks/javascript-sdk","siteSpaceId":"sitesp_BV6eG","description":"The official PredictHQ JavaScript Client provides a consistent JavaScript interface to our API.","breadcrumbs":[{"label":"Tech Docs"},{"label":"PredictHQ SDKs"}]},{"id":"TvXhvTzgP9p9T28I4fsD","title":"API reference","pathname":"/api","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"}]},{"id":"D6wkdArlk0PhRzN5hUjE","title":"Authenticating","pathname":"/api/overview/authenticating","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Overview"}]},{"id":"dHvDh4oqyXfBdXHBeQDi","title":"API specs","pathname":"/api/overview/api-specs","siteSpaceId":"sitesp_vLjzO","description":"We provide OpenAPI specs for all our APIs","breadcrumbs":[{"label":"API Reference"},{"label":"Overview"}]},{"id":"Bhydv5SXvOiCr2Bf3fLK","title":"Rate limits","pathname":"/api/overview/rate-limits","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Overview"}]},{"id":"LNgj3fI3hH4ka4kOat6Y","title":"Pagination","pathname":"/api/overview/pagination","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Overview"}]},{"id":"8TjddlrxV9LbUYoBNwpz","title":"API changes","pathname":"/api/overview/api-changes","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Overview"}]},{"id":"tN4oQpCXWPGJrgh5dCVl","title":"Attribution","pathname":"/api/overview/attribution","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Overview"}]},{"id":"uA9CLP8Ap5ZntZ8NYnqV","title":"Troubleshooting","pathname":"/api/overview/troubleshooting","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Overview"}]},{"id":"pGoVXtUcPLoiLOKBUJ4H","title":"Search events","pathname":"/api/events/search-events","siteSpaceId":"sitesp_vLjzO","description":"Verified real-world events for grounding AI systems, explaining forecasts, and retrieval at decision time—structured, deduplicated, and enriched.","breadcrumbs":[{"label":"API Reference"},{"label":"Events"}]},{"id":"q3Xg3GQy3xoSq1Lblvfw","title":"Get event counts","pathname":"/api/events/get-event-counts","siteSpaceId":"sitesp_vLjzO","description":"Get the count of events by category, PHQ Label and more.","breadcrumbs":[{"label":"API Reference"},{"label":"Events"}]},{"id":"UZQdrMghcMt6jmwSXxYX","title":"Search Broadcasts","pathname":"/api/broadcasts/search-broadcasts","siteSpaceId":"sitesp_vLjzO","description":"Search for Live TV broadcasts happening in a location.","breadcrumbs":[{"label":"API Reference"},{"label":"Broadcasts"}]},{"id":"9D1NVIsGx0LPa2lP2cmK","title":"Get Broadcasts count","pathname":"/api/broadcasts/get-broadcasts-count","siteSpaceId":"sitesp_vLjzO","description":"Get the count of Live TV broadcasts by category, label and more.","breadcrumbs":[{"label":"API Reference"},{"label":"Broadcasts"}]},{"id":"sO9OkWnm0V0RjLSfgDl4","title":"Get ML features","pathname":"/api/features/get-features","siteSpaceId":"sitesp_vLjzO","description":"Model-ready features engineered from real-world events. Train forecasting models on historical windows and retrieve future-dated values at inference.","breadcrumbs":[{"label":"API Reference"},{"label":"Features"}]},{"id":"6ftsthOApI5bMBfiSCHe","title":"Overview","pathname":"/api/forecasts/overview","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"}]},{"id":"6Ip97cJbHaA8qzdlMkEl","title":"Models","pathname":"/api/forecasts/models","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"}]},{"id":"xVSDIWbbm4uyF4MRnlEX","title":"Create model","pathname":"/api/forecasts/models/create-model","siteSpaceId":"sitesp_vLjzO","description":"Create a forecast model.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Models"}]},{"id":"9TJpTno2oaNtWkFPNH3q","title":"Update model","pathname":"/api/forecasts/models/update-model","siteSpaceId":"sitesp_vLjzO","description":"Update an existing forecast model.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Models"}]},{"id":"pdNSBjTUUPgXr47oUnB3","title":"Replace model","pathname":"/api/forecasts/models/replace-model","siteSpaceId":"sitesp_vLjzO","description":"Replace an existing forecast model.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Models"}]},{"id":"1D4DDF9ArB15EkyxPXDy","title":"Delete model","pathname":"/api/forecasts/models/delete-model","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Models"}]},{"id":"j9EuYp3tzJ605Cgbwyfh","title":"Search models","pathname":"/api/forecasts/models/search-models","siteSpaceId":"sitesp_vLjzO","description":"Search forecast models.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Models"}]},{"id":"RZ4NT4DoPkATWGQPgLRg","title":"Get model","pathname":"/api/forecasts/models/get-model","siteSpaceId":"sitesp_vLjzO","description":"Get an existing forecast model.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Models"}]},{"id":"Zr3J24xxjzXLucfaRCDR","title":"Train model","pathname":"/api/forecasts/models/train-model","siteSpaceId":"sitesp_vLjzO","description":"Train an existing forecast model.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Models"}]},{"id":"CTrttjVAPUhTo2KG72Mf","title":"Demand data","pathname":"/api/forecasts/demand-data","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"}]},{"id":"yADx1VLDysblGFFaXDqv","title":"Upload demand data","pathname":"/api/forecasts/demand-data/upload-demand-data","siteSpaceId":"sitesp_vLjzO","description":"Upload historical demand data for an existing forecast model.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Demand data"}]},{"id":"bsriwA4WMZqrajojHMZq","title":"Get demand data","pathname":"/api/forecasts/demand-data/get-demand-data","siteSpaceId":"sitesp_vLjzO","description":"Get previously uploaded demand data.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Demand data"}]},{"id":"nAMc5r6vRJGH16FlsxX9","title":"Forecasts","pathname":"/api/forecasts/forecasts","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"}]},{"id":"7Mrf6KLMZHTXtwNp7fwR","title":"Get forecast","pathname":"/api/forecasts/forecasts/get-forecast","siteSpaceId":"sitesp_vLjzO","description":"Get forecast values for an existing model.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Forecasts"}]},{"id":"cAieIaB3bzj25d07jKf4","title":"Algorithms","pathname":"/api/forecasts/algorithms","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"}]},{"id":"OSpRZ2c1GlbxDOl2854f","title":"Get algorithms","pathname":"/api/forecasts/algorithms/get-algorithms","siteSpaceId":"sitesp_vLjzO","description":"Get available algorithms.","breadcrumbs":[{"label":"API Reference"},{"label":"Forecasts"},{"label":"Algorithms"}]},{"id":"7aOrjCnZBqr0dSye0bZK","title":"Overview","pathname":"/api/beam/overview","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"}]},{"id":"TF0NH9xetDmK4t3eiYqC","title":"Analyses","pathname":"/api/beam/analyses","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"}]},{"id":"UgiRagMDVyZAbSK0FeEs","title":"Create an Analysis","pathname":"/api/beam/analyses/create-an-analysis","siteSpaceId":"sitesp_vLjzO","description":"Creating an Analysis is the first step in understand which types of events impact your demand.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"FgWxC40kgSZMj9O2IRfw","title":"Update an Analysis","pathname":"/api/beam/analyses/update-an-analysis","siteSpaceId":"sitesp_vLjzO","description":"Update (replace) an existing Analysis.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"OiQE5DrtuuastBSqiFju","title":"Partially update an Analysis","pathname":"/api/beam/analyses/partially-update-an-analysis","siteSpaceId":"sitesp_vLjzO","description":"Partially update an existing Analysis.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"ZRik5AE7uBsa0Z2p3DAT","title":"Delete an Analysis","pathname":"/api/beam/analyses/delete-an-analysis","siteSpaceId":"sitesp_vLjzO","description":"Delete an existing Analysis.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"ah0ylR1kqOeWbGFv6NLL","title":"Search Analyses","pathname":"/api/beam/analyses/search-analyses","siteSpaceId":"sitesp_vLjzO","description":"Search for an existing Analysis.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"8z9FZEQa6rSvLDrIWGsz","title":"Get an Analysis","pathname":"/api/beam/analyses/get-an-analysis","siteSpaceId":"sitesp_vLjzO","description":"Get an existing Analysis.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"EiXzvqGpXmD3pmAupxS4","title":"Refresh an Analysis","pathname":"/api/beam/analyses/refresh-an-analysis","siteSpaceId":"sitesp_vLjzO","description":"Rerun the Beam correlation and analysis process.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"ivxeWkpCXixPeigdZ0Ms","title":"Upload demand data","pathname":"/api/beam/analyses/upload-demand-data","siteSpaceId":"sitesp_vLjzO","description":"Upload your demand data as CSV, line-delimited JSON or JSON.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"TLA8bgK5lqwjvTcbDAoJ","title":"Get correlation results","pathname":"/api/beam/analyses/get-correlation","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"8qa3HcV4bIaQordMEGFG","title":"Get Feature Importance","pathname":"/api/beam/analyses/get-feature-importance","siteSpaceId":"sitesp_vLjzO","description":"Get relevant ML features based on a Beam Analysis.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analyses"}]},{"id":"MxEtMRkhs4WtC5DSolEX","title":"Analysis Groups","pathname":"/api/beam/analysis-groups","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"}]},{"id":"eBJ3eIFuJCDrYxDQE5Wc","title":"Create an Analysis Group","pathname":"/api/beam/analysis-groups/create-an-analysis-group","siteSpaceId":"sitesp_vLjzO","description":"Creating an Analysis Group allows to aggregate Feature Importance for a number of Analyses","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"G9CuxBcEmWSsW8brM1Zt","title":"Update an Analysis Group","pathname":"/api/beam/analysis-groups/update-an-analysis-group","siteSpaceId":"sitesp_vLjzO","description":"Update (replace) an existing Analysis Group.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"Jq0jF5XVSv3fpgd3XouL","title":"Partially update an Analysis Group","pathname":"/api/beam/analysis-groups/partially-update-an-analysis-group","siteSpaceId":"sitesp_vLjzO","description":"Partially update an existing Analysis Group.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"wLXRQYhb73qo5NXRPaKt","title":"Delete an Analysis Group","pathname":"/api/beam/analysis-groups/delete-an-analysis-group","siteSpaceId":"sitesp_vLjzO","description":"Delete an existing Analysis Group.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"e5ft7afURI7U79uyzWJD","title":"Search Analysis Groups","pathname":"/api/beam/analysis-groups/search-analysis-groups","siteSpaceId":"sitesp_vLjzO","description":"Search for an existing Analysis Group.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"0dC72VDoODieMKLx7UIp","title":"Get an Analysis Group","pathname":"/api/beam/analysis-groups/get-an-analysis-group","siteSpaceId":"sitesp_vLjzO","description":"Get an existing Analysis Group.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"MUVXviNHkl7bCSy5LLWA","title":"Refresh an Analysis Group","pathname":"/api/beam/analysis-groups/refresh-an-analysis-group","siteSpaceId":"sitesp_vLjzO","description":"Re-run the Beam Analysis Group aggregation process.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"iYkLjMluYvnfEMEH9l5Q","title":"Get Feature Importance for an Analysis Group","pathname":"/api/beam/analysis-groups/get-aggregated-feature-importance","siteSpaceId":"sitesp_vLjzO","description":"Get Feature Importance data for an Analysis Group.","breadcrumbs":[{"label":"API Reference"},{"label":"Beam"},{"label":"Analysis Groups"}]},{"id":"pftwcpkJfJHgZY1g9WtO","title":"Get Predicted Impact Area","pathname":"/api/impact-area/get-impact-area","siteSpaceId":"sitesp_vLjzO","description":"Determine the area around a location where events are likely to influence demand.","breadcrumbs":[{"label":"API Reference"},{"label":"Predicted Impact Area"}]},{"id":"0hjL6KTLwYAwMtukriuq","title":"Get Suggested Radius","pathname":"/api/suggested-radius/get-suggested-radius","siteSpaceId":"sitesp_vLjzO","description":"Take the guesswork out of working out a suitable radius around your business when searching for events.","breadcrumbs":[{"label":"API Reference"},{"label":"Suggested Radius"}]},{"id":"I91XddU20PYeMODQZV6E","title":"Overview","pathname":"/api/saved-locations/overview","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Saved Locations"}]},{"id":"9B75tmFSpZeFyzBJ36yR","title":"Create a Saved Location","pathname":"/api/saved-locations/create-a-saved-location","siteSpaceId":"sitesp_vLjzO","description":"Create a new Saved Location to begin seeing insights.","breadcrumbs":[{"label":"API Reference"},{"label":"Saved Locations"}]},{"id":"x5DRPXjvOkTiIT7SPLp6","title":"Update a Saved Location","pathname":"/api/saved-locations/update-a-saved-location","siteSpaceId":"sitesp_vLjzO","description":"Update (replace) an existing Saved Location.","breadcrumbs":[{"label":"API Reference"},{"label":"Saved Locations"}]},{"id":"xIzEQUwjLQPCmWWkmKI9","title":"Delete a Saved Location","pathname":"/api/saved-locations/delete-a-saved-location","siteSpaceId":"sitesp_vLjzO","description":"Delete an existing Saved Location.","breadcrumbs":[{"label":"API Reference"},{"label":"Saved Locations"}]},{"id":"VKnpETZoBSQQlGJMaYRb","title":"Search Saved Locations","pathname":"/api/saved-locations/search-saved-locations","siteSpaceId":"sitesp_vLjzO","description":"Search for existing Saved Locations.","breadcrumbs":[{"label":"API Reference"},{"label":"Saved Locations"}]},{"id":"eVr6YahfNA2UFet90S4a","title":"Get a Saved Location","pathname":"/api/saved-locations/get-a-saved-location","siteSpaceId":"sitesp_vLjzO","description":"Get an existing Saved Location.","breadcrumbs":[{"label":"API Reference"},{"label":"Saved Locations"}]},{"id":"wBbSxaCaceVhdLcaBleG","title":"Search events for a Saved Location","pathname":"/api/saved-locations/search-events-for-a-saved-location","siteSpaceId":"sitesp_vLjzO","description":"Search for events happening in an existing Saved Location.","breadcrumbs":[{"label":"API Reference"},{"label":"Saved Locations"}]},{"id":"F1nL8851CWepqgz1N8jr","title":"Overview","pathname":"/api/loop/overview","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"}]},{"id":"3iqFT6CRtrMSB0iiThXw","title":"Loop Links","pathname":"/api/loop/loop-links","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"}]},{"id":"8IHtTapmkOjYnQbabjI2","title":"Create a Loop Link","pathname":"/api/loop/loop-links/create-a-loop-link","siteSpaceId":"sitesp_vLjzO","description":"Create a new Loop Link to begin submitting events and feedback.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop Links"}]},{"id":"QZhyh0VBQT2Rd3RhtyUE","title":"Search Loop Links","pathname":"/api/loop/loop-links/search-loop-links","siteSpaceId":"sitesp_vLjzO","description":"Search existing Loop Links.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop Links"}]},{"id":"REqgIdz0kHhrnpLDwA6H","title":"Get a Loop Link","pathname":"/api/loop/loop-links/get-a-loop-link","siteSpaceId":"sitesp_vLjzO","description":"Get an existing Loop Link.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop Links"}]},{"id":"MgVn5N4pSHiVeChLxjiE","title":"Update a Loop Link","pathname":"/api/loop/loop-links/update-a-loop-link","siteSpaceId":"sitesp_vLjzO","description":"Update (replace) an existing Loop Link.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop Links"}]},{"id":"RnbQsT2LNlX0FwwmUCH5","title":"Delete a Loop Link","pathname":"/api/loop/loop-links/delete-a-loop-link","siteSpaceId":"sitesp_vLjzO","description":"Delete an existing Loop Link.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop Links"}]},{"id":"gqiok5mZLyDiNsP19knL","title":"Loop settings","pathname":"/api/loop/loop-settings","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"}]},{"id":"lNxCX3L5crneZ8CEEuSA","title":"Get Loop settings","pathname":"/api/loop/loop-settings/get-loop-settings","siteSpaceId":"sitesp_vLjzO","description":"Loop settings are used to control how certain elements might be displayed inside the Loop UI.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop settings"}]},{"id":"CZQFP2ODmcQrfYHLukF7","title":"Update Loop settings","pathname":"/api/loop/loop-settings/update-loop-settings","siteSpaceId":"sitesp_vLjzO","description":"Update your Loop Settings.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop settings"}]},{"id":"7G36gz93GiqGY8PLdooW","title":"Loop submissions","pathname":"/api/loop/loop-submissions","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"}]},{"id":"pS03WBg0vBieVtTOLLiK","title":"Search submitted events","pathname":"/api/loop/loop-submissions/search-submitted-events","siteSpaceId":"sitesp_vLjzO","description":"Search events submitted by your organization.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop submissions"}]},{"id":"qffU1viSYq5U1H8Fzq1h","title":"Loop feedback","pathname":"/api/loop/loop-feedback","siteSpaceId":"sitesp_vLjzO","description":"","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"}]},{"id":"GCAeRlaNk9q1Ug9ejQRR","title":"Search feedback","pathname":"/api/loop/loop-feedback/search-feedback","siteSpaceId":"sitesp_vLjzO","description":"Search feedback conversations submitted by your organization.","breadcrumbs":[{"label":"API Reference"},{"label":"Loop"},{"label":"Loop feedback"}]},{"id":"CeBEdVo0z786331Kxf1M","title":"Search places","pathname":"/api/places/search-places","siteSpaceId":"sitesp_vLjzO","description":"Search for a Place.","breadcrumbs":[{"label":"API Reference"},{"label":"Places"}]},{"id":"Gd3TgrwVoh2UkEUyE7Nc","title":"Get place hierarchies","pathname":"/api/places/get-place-hierarchies","siteSpaceId":"sitesp_vLjzO","description":"Get the list of hierarchies for a Place.","breadcrumbs":[{"label":"API Reference"},{"label":"Places"}]},{"id":"yr5zrmZQUbOkl5X1aL9W","title":"Get demand surges","pathname":"/api/demand-surge/get-demand-surges","siteSpaceId":"sitesp_vLjzO","description":"Identify dates with surges in demand caused by multiple events happening at the same time and location.","breadcrumbs":[{"label":"API Reference"},{"label":"Demand Surge"}]},{"id":"Bu5qdk6XQQqDpRSiAANX","title":"Changelog","pathname":"/changelog","siteSpaceId":"sitesp_3eaBa","description":"A record of product updates, data quality improvements, and new features across the PredictHQ platform. Updated each release cycle.","breadcrumbs":[{"label":"Changelog"}]},{"id":"HzEOWBoIPyV8T3k2pTlT","title":"2025 changelog","pathname":"/changelog/2025","siteSpaceId":"sitesp_3eaBa","description":"","breadcrumbs":[{"label":"Changelog"}]}]}