> For the complete documentation index, see [llms.txt](https://docs.predicthq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.predicthq.com/getting-started.md).

# Getting started

- [API quickstart](https://docs.predicthq.com/getting-started/api-quickstart.md): Get your API key, make your first call, and understand how PredictHQ fits into a production integration.
- [Tutorials](https://docs.predicthq.com/getting-started/tutorials.md)
- [Measure the forecast lift on sample data](https://docs.predicthq.com/getting-started/tutorials/measure-the-forecast-lift.md): 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.
- [Core concepts](https://docs.predicthq.com/getting-started/core-concepts.md)
- [Event-driven demand](https://docs.predicthq.com/getting-started/core-concepts/event-driven-demand.md): Using real-world events to improve forecasting and operational decisions introduces structural challenges around scope, relevance, usability, and trust.
- [What is Beam?](https://docs.predicthq.com/getting-started/core-concepts/what-is-beam.md)
- [What is the Features API?](https://docs.predicthq.com/getting-started/core-concepts/what-is-the-features-api.md)
- [Which API should I use?](https://docs.predicthq.com/getting-started/core-concepts/which-api-should-i-use.md)
- [Data leakage in backtesting: why it doesn't affect forecast accuracy](https://docs.predicthq.com/getting-started/core-concepts/data-leakage-in-backtesting.md)
- [Guide to protecting PredictHQ data](https://docs.predicthq.com/getting-started/core-concepts/guide-to-protecting-predicthq-data.md): It's important to protect PredictHQ data from unauthorized access and usage.
- [Glossary](https://docs.predicthq.com/getting-started/glossary.md): Definitions of key terms used across PredictHQ’s platform and APIs. Use as a reference.
- [Data science notebooks](https://docs.predicthq.com/getting-started/data-science-notebooks.md): Jupyter notebooks for training and improving demand forecasting models with PredictHQ event features—Beam calibration, model-ready features, and worked forecasting examples.
- [PredictHQ data](https://docs.predicthq.com/getting-started/predicthq-data.md)
- [Data accuracy](https://docs.predicthq.com/getting-started/predicthq-data/data-accuracy.md)
- [Event categories](https://docs.predicthq.com/getting-started/predicthq-data/event-categories.md)
- [Attendance-based events](https://docs.predicthq.com/getting-started/predicthq-data/event-categories/attendance-based-events.md): Attended Events are gatherings with a start and end date/time, where people come together in one location for entertainment or business.
- [Non-Attendance-based events](https://docs.predicthq.com/getting-started/predicthq-data/event-categories/non-attendance-based-events.md): 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.
- [Unscheduled events](https://docs.predicthq.com/getting-started/predicthq-data/event-categories/unscheduled-events.md): Live coverage of breaking events such as severe weather and terrorism. The API updates minute to minute to ensure accuracy.
- [Live TV events](https://docs.predicthq.com/getting-started/predicthq-data/event-categories/live-tv-events.md): 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.
- [Labels](https://docs.predicthq.com/getting-started/predicthq-data/labels.md): Event labels are succinct descriptive attributes attached to events that can help with granular data selection and feature engineering use cases.
- [Entities](https://docs.predicthq.com/getting-started/predicthq-data/entities.md)
- [Ranks](https://docs.predicthq.com/getting-started/predicthq-data/ranks.md)
- [PHQ Rank](https://docs.predicthq.com/getting-started/predicthq-data/ranks/phq-rank.md)
- [Local Rank](https://docs.predicthq.com/getting-started/predicthq-data/ranks/local-rank.md)
- [Predicted Attendance](https://docs.predicthq.com/getting-started/predicthq-data/predicted-attendance.md): Predicted Attendance represents the number of people predicted to attend an event.
- [Predicted End Times](https://docs.predicthq.com/getting-started/predicthq-data/predicted-end-times.md)
- [Predicted Event Spend](https://docs.predicthq.com/getting-started/predicthq-data/predicted-event-spend.md)
- [Predicted Events](https://docs.predicthq.com/getting-started/predicthq-data/predicted-events.md): Get insight into events as early as possible, to assess whether they would have an impact on your business.
- [Predicted Impact Patterns](https://docs.predicthq.com/getting-started/predicthq-data/impact-patterns.md)
- [Guides](https://docs.predicthq.com/getting-started/guides.md)
- [Geolocation guides](https://docs.predicthq.com/getting-started/guides/geolocation-guides.md)
- [Overview](https://docs.predicthq.com/getting-started/guides/geolocation-guides/overview.md)
- [Searching by location](https://docs.predicthq.com/getting-started/guides/geolocation-guides/searching-by-location.md)
- [Find events by latitude/longitude and radius](https://docs.predicthq.com/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-latitude-longitude-and-radius.md)
- [Find events by place ID](https://docs.predicthq.com/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-place-id.md)
- [Find events by IATA code](https://docs.predicthq.com/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-iata-code.md)
- [Find events by country code](https://docs.predicthq.com/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-country-code.md)
- [Find events by Placekey](https://docs.predicthq.com/getting-started/guides/geolocation-guides/searching-by-location/find-events-by-placekey.md)
- [Working with location-based subscriptions](https://docs.predicthq.com/getting-started/guides/geolocation-guides/searching-by-location/working-with-location-based-subscriptions.md)
- [Understanding place hierarchies](https://docs.predicthq.com/getting-started/guides/geolocation-guides/understanding-place-hierarchies.md)
- [Working with polygons](https://docs.predicthq.com/getting-started/guides/geolocation-guides/working-with-polygons.md)
- [Join events using Placekey](https://docs.predicthq.com/getting-started/guides/geolocation-guides/join-events-using-placekey.md)
- [Date and time guides](https://docs.predicthq.com/getting-started/guides/date-and-time-guides.md)
- [Working with recurring events](https://docs.predicthq.com/getting-started/guides/date-and-time-guides/working-with-recurring-events.md)
- [Working with multi-day and umbrella events](https://docs.predicthq.com/getting-started/guides/date-and-time-guides/working-with-multi-day-and-umbrella-events.md): How to interpret phq\_attendance for multi-day events and avoid double-counting umbrella events when working with individual event records.
- [Working with dates, times and timezones](https://docs.predicthq.com/getting-started/guides/date-and-time-guides/working-with-dates-times-and-timezones.md): Working with dates, times and timezones can be hard.This guide aims to clarify how to work with these with PredictHQ data.
- [Events API guides](https://docs.predicthq.com/getting-started/guides/events-api-guides.md)
- [Filtering and finding relevant events](https://docs.predicthq.com/getting-started/guides/events-api-guides/filtering-and-finding-relevant-events.md): Learn how to filter and find events relevant to your business using PredictHQ's Events API.
- [Displaying events in a heatmap calendar](https://docs.predicthq.com/getting-started/guides/events-api-guides/displaying-events-in-a-heatmap-calendar.md): Learn how to create a heatmap-styled calendar to display event attendance for a location.
- [Displaying events on a map](https://docs.predicthq.com/getting-started/guides/events-api-guides/displaying-events-on-a-map.md): Learn how to display events on a map for a specific location.
- [Features API guides](https://docs.predicthq.com/getting-started/guides/features-api-guides.md)
- [Improving demand forecasting models with event features](https://docs.predicthq.com/getting-started/guides/features-api-guides/improving-demand-forecasting-models-with-event-features.md): Learn how to integrate PredictHQ's event features into your demand forecasting model.
- [Forecasting demand in Power BI with event features](https://docs.predicthq.com/getting-started/guides/features-api-guides/integrate-with-a-demand-forecast-in-powerbi.md): Use PowerBI's AutoML models to forecast demand using PredictHQ technologies.
- [Using event features with time series foundation models](https://docs.predicthq.com/getting-started/guides/features-api-guides/using-event-features-with-time-series-foundation-models.md): Supply PredictHQ event features as future covariates to pre-trained forecasting models such as Chronos, TimesFM, and TimeGPT.
- [Forecasts API guides](https://docs.predicthq.com/getting-started/guides/forecasts-api-guides.md)
- [Getting started with Forecasts API](https://docs.predicthq.com/getting-started/guides/forecasts-api-guides/getting-started.md)
- [Understanding forecast accuracy metrics](https://docs.predicthq.com/getting-started/guides/forecasts-api-guides/understanding-forecast-accuracy-metrics.md)
- [Troubleshooting guide for Forecasts API](https://docs.predicthq.com/getting-started/guides/forecasts-api-guides/troubleshooting.md)
- [Live TV event guides](https://docs.predicthq.com/getting-started/guides/live-tv-event-guides.md)
- [Find Broadcasts by county place ID](https://docs.predicthq.com/getting-started/guides/live-tv-event-guides/find-broadcasts-by-county-place-id.md)
- [Find Broadcasts by latitude and longitude](https://docs.predicthq.com/getting-started/guides/live-tv-event-guides/find-broadcasts-by-latitude-and-longitude.md)
- [Find all Broadcasts for an event](https://docs.predicthq.com/getting-started/guides/live-tv-event-guides/find-all-broadcasts-for-an-event.md)
- [Find Broadcasts for specific sport types](https://docs.predicthq.com/getting-started/guides/live-tv-event-guides/find-broadcasts-for-specific-sport-types.md): Better understand predicted vs scheduled broadcasts as well as different sport types.
- [Aggregating live TV events](https://docs.predicthq.com/getting-started/guides/live-tv-event-guides/aggregating-live-tv-events.md)
- [Beam guides](https://docs.predicthq.com/getting-started/guides/beam-guides.md)
- [Understanding demand variability and event contribution in Beam](https://docs.predicthq.com/getting-started/guides/beam-guides/understanding-demand-variability-and-event-contribution-in-beam.md)
- [Sample demand data](https://docs.predicthq.com/getting-started/guides/beam-guides/sample-demand-data.md)
- [Streamlit demo apps](https://docs.predicthq.com/getting-started/guides/streamlit-demo-apps.md)
- [Industry recommendations](https://docs.predicthq.com/getting-started/guides/industry-specific-event-filters.md): 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.
- [Use case guides](https://docs.predicthq.com/getting-started/use-case-guides.md)
- [Accommodation: the proven path to value](https://docs.predicthq.com/getting-started/use-case-guides/accommodation-the-proven-path-to-value.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.predicthq.com/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.