# PredictHQ Tech Docs ## Tech Docs - [Overview](https://docs.predicthq.com/readme.md): Docs, guides, and API references to help you build with PredictHQ. - [How to use PredictHQ](https://docs.predicthq.com/how-to-use-predicthq.md): 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. - [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): Attendance-based 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-2, 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) - [Build with AI](https://docs.predicthq.com/ai/build-with-ai.md): Ground AI systems in verified real-world event data and build integrations faster with the MCP server, agent skills, and AI-readable docs. - [Grounding with PredictHQ](https://docs.predicthq.com/ai/grounding-with-predicthq.md): 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. - [MCP server](https://docs.predicthq.com/ai/mcp.md): Connect AI agents to verified real-world event context on demand. On-demand grounding for LLMs via the Model Context Protocol - no data pipeline to maintain. - [PredictHQ MCP in agentic workflows](https://docs.predicthq.com/ai/predicthq-mcp-in-agentic-workflows.md): Reference architectures for autonomous agents that query the PredictHQ MCP server for verified demand context at decision time. - [Agent skills](https://docs.predicthq.com/ai/agent-skills.md): Install PredictHQ agent skills to give AI coding assistants best-practice integration knowledge - recommended workflow, API selection, and Beam guidance, which your agent applies automatically while y - [Bolt](https://docs.predicthq.com/ai/bolt.md): An AI-native notebook inside the PredictHQ WebApp. Bolt answers from live PredictHQ API data—a working example of a grounded agent. - [Integration guides](https://docs.predicthq.com/integrations/integration-guides.md) - [Standard integration pattern](https://docs.predicthq.com/integrations/integration-guides/standard-integration-pattern.md) - [Provisioned grounding: retrieval inside your environment](https://docs.predicthq.com/integrations/integration-guides/provisioned-grounding.md): Reference architecture for provisioned grounding: retrieving verified PredictHQ event context inside your own environment at answer time, so your AI systems respond from facts they can cite. - [Keep data updated via API](https://docs.predicthq.com/integrations/integration-guides/keep-data-updated-via-api.md): Event information changes frequently. For example, a date changes, an event gets canceled, or ranking is updated. It’s important to keep your data set up to date. - [Loading event data into a data warehouse](https://docs.predicthq.com/integrations/integration-guides/loading-event-data-into-a-data-warehouse.md): Take PredictHQ API data and load it into a data warehouse, in this example, GCP BigQuery. - [Integrate with Loop Links](https://docs.predicthq.com/integrations/integration-guides/integrate-with-loop-links.md): Loop Links let you submit missing events and provide feedback on existing events. - [Third-party integrations](https://docs.predicthq.com/integrations/third-party-integrations.md) - [Receive data via Snowflake](https://docs.predicthq.com/integrations/third-party-integrations/snowflake.md) - [Example SQL queries for Snowflake](https://docs.predicthq.com/integrations/third-party-integrations/snowflake/example-sql-queries-for-snowflake.md) - [Snowflake data science guide](https://docs.predicthq.com/integrations/third-party-integrations/snowflake/snowflake-data-science-guide.md): Transforming Event Data into ML-Ready Features in Snowflake - [Snowpark method guide](https://docs.predicthq.com/integrations/third-party-integrations/snowflake/snowflake-data-science-guide/snowpark-method-guide.md): Transforming Event Data into ML-Ready Features using Snowpark and Python - [SQL method guide](https://docs.predicthq.com/integrations/third-party-integrations/snowflake/snowflake-data-science-guide/sql-method-guide.md): Transforming Event Data into ML-Ready Features using SQL - [Receive data via AWS Data Exchange](https://docs.predicthq.com/integrations/third-party-integrations/aws-data-exchange.md) - [CSV/Parquet data structure for ADX](https://docs.predicthq.com/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md): Data can be provided as NDJSON, CSV, or Parquet. This document describes the CSV/Parquet data structure. - [NDJSON data structure for ADX](https://docs.predicthq.com/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md): Data can be provided as NDJSON, CSV or Parquet. This document describes the NDJSON data structure. - [Receive data via SFTP](https://docs.predicthq.com/integrations/third-party-integrations/sftp.md) - [Integrate with Databricks](https://docs.predicthq.com/integrations/third-party-integrations/integrate-with-databricks.md): Deploy PredictHQ's verified real-world context into Databricks via S3 or Snowflake for model training, inference-time features, and grounding AI systems. - [Using event data in Tableau](https://docs.predicthq.com/integrations/third-party-integrations/using-event-data-in-tableau.md): Learn how to connect PredictHQ data to Tableau and build an example dashboard. - [Using event data in Power BI](https://docs.predicthq.com/integrations/third-party-integrations/using-event-data-in-power-bi.md): Learn how to connect PredictHQ data to Power BI using multiple methods, and build an example report. - [Connecting to PredictHQ APIs with Microsoft Excel](https://docs.predicthq.com/integrations/third-party-integrations/connecting-to-predicthq-apis-with-microsoft-excel.md): Learn how to connect PredictHQ data to Microsoft Excel using APIs. - [Python SDK](https://docs.predicthq.com/sdks/python-sdk.md): The official PredictHQ Python Client provides a consistent, pythonic interface to our API. - [JavaScript SDK](https://docs.predicthq.com/sdks/javascript-sdk.md): The official PredictHQ JavaScript Client provides a consistent JavaScript interface to our API. ## API Reference - [API reference](https://docs.predicthq.com/api/readme.md) - [Authenticating](https://docs.predicthq.com/api/overview/authenticating.md) - [API specs](https://docs.predicthq.com/api/overview/api-specs.md): We provide OpenAPI specs for all our APIs - [Rate limits](https://docs.predicthq.com/api/overview/rate-limits.md) - [Pagination](https://docs.predicthq.com/api/overview/pagination.md) - [API changes](https://docs.predicthq.com/api/overview/api-changes.md) - [Attribution](https://docs.predicthq.com/api/overview/attribution.md) - [Troubleshooting](https://docs.predicthq.com/api/overview/troubleshooting.md) - [Search events](https://docs.predicthq.com/api/events/search-events.md): Verified real-world events for grounding AI systems, explaining forecasts, and retrieval at decision time—structured, deduplicated, and enriched. - [Get event counts](https://docs.predicthq.com/api/events/get-event-counts.md): Get the count of events by category, PHQ Label, and more. - [Search Broadcasts](https://docs.predicthq.com/api/broadcasts/search-broadcasts.md): Search for Live TV broadcasts happening in a location. - [Get Broadcasts count](https://docs.predicthq.com/api/broadcasts/get-broadcasts-count.md): Get the count of Broadcasts for Live TV Events by category, label, and more. - [Get ML features](https://docs.predicthq.com/api/features/get-features.md): Model-ready features engineered from real-world events. Train forecasting models on historical windows and retrieve future-dated values at inference. - [Overview](https://docs.predicthq.com/api/forecasts/overview.md) - [Models](https://docs.predicthq.com/api/forecasts/models.md) - [Create model](https://docs.predicthq.com/api/forecasts/models/create-model.md): Create a forecast model. - [Update model](https://docs.predicthq.com/api/forecasts/models/update-model.md): Update an existing forecast model. - [Replace model](https://docs.predicthq.com/api/forecasts/models/replace-model.md): Replace an existing forecast model. - [Delete model](https://docs.predicthq.com/api/forecasts/models/delete-model.md) - [Search models](https://docs.predicthq.com/api/forecasts/models/search-models.md): Search forecast models. - [Get model](https://docs.predicthq.com/api/forecasts/models/get-model.md): Get an existing forecast model. - [Train model](https://docs.predicthq.com/api/forecasts/models/train-model.md): Train an existing forecast model. - [Demand data](https://docs.predicthq.com/api/forecasts/demand-data.md) - [Upload demand data](https://docs.predicthq.com/api/forecasts/demand-data/upload-demand-data.md): Upload historical demand data for an existing forecast model. - [Get demand data](https://docs.predicthq.com/api/forecasts/demand-data/get-demand-data.md): Get previously uploaded demand data. - [Forecasts](https://docs.predicthq.com/api/forecasts/forecasts.md) - [Get forecast](https://docs.predicthq.com/api/forecasts/forecasts/get-forecast.md): Get forecast values for an existing model. - [Algorithms](https://docs.predicthq.com/api/forecasts/algorithms.md) - [Get algorithms](https://docs.predicthq.com/api/forecasts/algorithms/get-algorithms.md): Get available algorithms. - [Overview](https://docs.predicthq.com/api/beam/overview.md) - [Analyses](https://docs.predicthq.com/api/beam/analyses.md) - [Create an Analysis](https://docs.predicthq.com/api/beam/analyses/create-an-analysis.md): Creating an Analysis is the first step in understand which types of events impact your demand. - [Update an Analysis](https://docs.predicthq.com/api/beam/analyses/update-an-analysis.md): Update (replace) an existing Analysis. - [Partially update an Analysis](https://docs.predicthq.com/api/beam/analyses/partially-update-an-analysis.md): Partially update an existing Analysis. - [Delete an Analysis](https://docs.predicthq.com/api/beam/analyses/delete-an-analysis.md): Delete an existing Analysis. - [Search Analyses](https://docs.predicthq.com/api/beam/analyses/search-analyses.md): Search for an existing Analysis. - [Get an Analysis](https://docs.predicthq.com/api/beam/analyses/get-an-analysis.md): Get an existing Analysis. - [Refresh an Analysis](https://docs.predicthq.com/api/beam/analyses/refresh-an-analysis.md): Rerun the Beam correlation and analysis process. - [Upload demand data](https://docs.predicthq.com/api/beam/analyses/upload-demand-data.md): Upload your demand data as CSV, line-delimited JSON, or JSON. - [Get correlation results](https://docs.predicthq.com/api/beam/analyses/get-correlation.md) - [Get Feature Importance](https://docs.predicthq.com/api/beam/analyses/get-feature-importance.md): Get relevant ML features based on a Beam Analysis. - [Analysis Groups](https://docs.predicthq.com/api/beam/analysis-groups.md) - [Create an Analysis Group](https://docs.predicthq.com/api/beam/analysis-groups/create-an-analysis-group.md): Creating an Analysis Group allows to aggregate Feature Importance for a number of Analyses - [Update an Analysis Group](https://docs.predicthq.com/api/beam/analysis-groups/update-an-analysis-group.md): Update (replace) an existing Analysis Group. - [Partially update an Analysis Group](https://docs.predicthq.com/api/beam/analysis-groups/partially-update-an-analysis-group.md): Partially update an existing Analysis Group. - [Delete an Analysis Group](https://docs.predicthq.com/api/beam/analysis-groups/delete-an-analysis-group.md): Delete an existing Analysis Group. - [Search Analysis Groups](https://docs.predicthq.com/api/beam/analysis-groups/search-analysis-groups.md): Search for an existing Analysis Group. - [Get an Analysis Group](https://docs.predicthq.com/api/beam/analysis-groups/get-an-analysis-group.md): Get an existing Analysis Group. - [Refresh an Analysis Group](https://docs.predicthq.com/api/beam/analysis-groups/refresh-an-analysis-group.md): Re-run the Beam Analysis Group aggregation process. - [Get Feature Importance for an Analysis Group](https://docs.predicthq.com/api/beam/analysis-groups/get-aggregated-feature-importance.md): Get Feature Importance data for an Analysis Group. - [Get Predicted Impact Area](https://docs.predicthq.com/api/impact-area/get-impact-area.md): Determine the area around a location where events are likely to influence demand. - [Get Suggested Radius](https://docs.predicthq.com/api/suggested-radius/get-suggested-radius.md): Take the guesswork out of working out a suitable radius around your business when searching for events. - [Overview](https://docs.predicthq.com/api/saved-locations/overview.md) - [Create a Saved Location](https://docs.predicthq.com/api/saved-locations/create-a-saved-location.md): Create a new Saved Location to begin seeing insights. - [Update a Saved Location](https://docs.predicthq.com/api/saved-locations/update-a-saved-location.md): Update (replace) an existing Saved Location. - [Delete a Saved Location](https://docs.predicthq.com/api/saved-locations/delete-a-saved-location.md): Delete an existing Saved Location. - [Search Saved Locations](https://docs.predicthq.com/api/saved-locations/search-saved-locations.md): Search for existing Saved Locations. - [Get a Saved Location](https://docs.predicthq.com/api/saved-locations/get-a-saved-location.md): Get an existing Saved Location. - [Search events for a Saved Location](https://docs.predicthq.com/api/saved-locations/search-events-for-a-saved-location.md): Search for events happening in an existing Saved Location. - [Overview](https://docs.predicthq.com/api/loop/overview.md) - [Loop Links](https://docs.predicthq.com/api/loop/loop-links.md) - [Create a Loop Link](https://docs.predicthq.com/api/loop/loop-links/create-a-loop-link.md): Create a new Loop Link to begin submitting events and feedback. - [Search Loop Links](https://docs.predicthq.com/api/loop/loop-links/search-loop-links.md): Search existing Loop Links. - [Get a Loop Link](https://docs.predicthq.com/api/loop/loop-links/get-a-loop-link.md): Get an existing Loop Link. - [Update a Loop Link](https://docs.predicthq.com/api/loop/loop-links/update-a-loop-link.md): Update (replace) an existing Loop Link. - [Delete a Loop Link](https://docs.predicthq.com/api/loop/loop-links/delete-a-loop-link.md): Delete an existing Loop Link. - [Loop settings](https://docs.predicthq.com/api/loop/loop-settings.md) - [Get Loop settings](https://docs.predicthq.com/api/loop/loop-settings/get-loop-settings.md): Loop settings control how the Loop UI displays certain elements. - [Update Loop settings](https://docs.predicthq.com/api/loop/loop-settings/update-loop-settings.md): Update your Loop Settings. - [Loop submissions](https://docs.predicthq.com/api/loop/loop-submissions.md) - [Search submitted events](https://docs.predicthq.com/api/loop/loop-submissions/search-submitted-events.md): Search events submitted by your organization. - [Loop feedback](https://docs.predicthq.com/api/loop/loop-feedback.md) - [Search feedback](https://docs.predicthq.com/api/loop/loop-feedback/search-feedback.md): Search feedback conversations submitted by your organization. - [Search places](https://docs.predicthq.com/api/places/search-places.md): Search for a Place. - [Get place hierarchies](https://docs.predicthq.com/api/places/get-place-hierarchies.md): Get the list of hierarchies for a Place. - [Get demand surges](https://docs.predicthq.com/api/demand-surge/get-demand-surges.md): Identify dates with surges in demand caused by multiple events happening at the same time and location. ## Changelog - [Changelog](https://docs.predicthq.com/changelog/changelog.md): A record of product updates, data quality improvements, and new features across the PredictHQ platform. Updated each release cycle. - [2025 changelog](https://docs.predicthq.com/changelog/2025.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 This site has an agentic ask interface you may use to query the documentation dynamically by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.predicthq.com/index.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.