Calculate Event FeaturesCalculate one page of daily or weekly ML-ready event features for a required date range using either a Beam analysis or a manually configured location and feature set.
Count BroadcastsReturn the total number of PredictHQ broadcast records matching optional broadcast, schedule, date, viewership, location, and event filters, without returning result records.
Count EventsGet aggregate event counts by category, label, rank level, and the same date, location, rank, attendance, spend, and event filters supported by search.
Create Beam AnalysisCreate a Beam analysis that correlates an owned location's events with uploaded demand data.
Create Beam Analysis GroupCreate a Beam analysis group that aggregates feature importance across compatible analyses.
Create Forecast ModelCreate a forecast model for a Saved Location.
Create Loop LinkCreate a hosted Loop link for end users to submit missing events or event feedback, and return both shareable URLs.
Create Saved LocationCreate a reusable PredictHQ Saved Location from an exact business point, a custom GeoJSON area, or Geonames place IDs.
Create Saved Location ClosureCreate a closure period for a PredictHQ Saved Location.
Create Saved Location Opening HoursCreate opening hours for a Saved Location.
Delete Beam AnalysisSoft-delete a Beam Analysis.
Delete Beam Analysis GroupDelete an existing Beam Analysis Group without deleting the individual analyses in the group.
Delete Forecast ModelPermanently deletes a forecast model and all associated demand data and forecasts.
Delete Loop LinkSoft-delete a Loop link.
Delete Saved LocationPermanently delete a Saved Location and all of its associated insights data.
Delete Saved Location ClosureDelete a closure by ID from the specified PredictHQ Saved Location.
Delete Saved Location Opening HoursDelete an opening hours record by ID from the specified PredictHQ Saved Location.
Get Beam AnalysisReturn the full details of one Beam Analysis, including its location, demand type, rank, readiness status, and processing state.
Get Beam Analysis Feature ImportanceReturn the Beam feature groups whose statistical significance indicates how strongly they affect an analysis's demand, including the Features API fields recommended for forecasting models.
Get Beam Analysis GroupReturn the full details of one Beam Analysis Group, including its member analyses, demand type, readiness status, and processing state.
Get Beam Analysis Group Feature ImportanceReturn feature-importance results aggregated across the analyses in an existing Beam Analysis Group, including each feature group's Features API fields and p-value.
Get Demand SurgesReturn dates with at least the requested demand-surge intensity for a required date and location, including summed predicted attendance.
Get Forecast ModelRetrieves a forecast model by ID, including its readiness status, configuration, accuracy metrics, and location details.
Get Loop LinkReturn one Loop Link, including its status, metadata, expiry, and hosted event-submission and event-feedback URLs.
Get Loop SettingsReturn the organization name displayed in the hosted Loop interface.
Get Predicted Impact AreaCalculate a polygonal or radial Predicted Impact Area for a business location and industry, returned as GeoJSON.
Get Saved LocationRetrieve a Saved Location by ID, including its geometry, enrichment status, labels, resolved places, summary insights, opening hours, and closures.
Get Saved Location ClosureReturn a single closure by ID for the specified Saved Location.
Get Saved Location Opening HoursReturn one opening hours record by its ID for a specified PredictHQ Saved Location.
List Beam AnalysesReturn one page of Beam Analyses, with filters for lifecycle state, readiness, groups, demand type, location, labels, update date, and name.
List Beam Analysis Correlation ResultsReturn one page of results correlating PredictHQ event data with an analysis's transactional demand data for a required lower and upper date bound.
List Beam Analysis GroupsReturn one page of Beam Analysis Groups, optionally filtered by update date, name, lifecycle state, readiness, demand interval, or industry.
List Forecast AlgorithmsReturns the list of available forecasting algorithms.
List Forecast Model DemandReturn one page of demand data uploaded to a forecast model, optionally filtered by date, as JSON, CSV, or newline-delimited JSON.
List Forecast ModelsReturn one page of forecast models belonging to the authenticated organization, optionally filtered by text, Saved Location, or readiness status.
List Loop Event SubmissionsReturn one page of Loop-submitted events matching link, event, user, review, state, category, location, and date filters.
List Loop Feedback ConversationsReturn one page of Loop feedback conversations matching record, link, user, feedback type, status, text, and date filters.
List Loop LinksReturn one page of hosted Loop links matching text, link, user, and sort filters.
List Model Forecast ResultsReturn one page of generated forecast results for a trained model, optionally filtered by date and enriched with features or event explainability.
List Place HierarchiesReturn one page of administrative hierarchy chains resolved from either place IDs or coordinates.
List Saved Location ClosuresReturn one page of closure records for a PredictHQ Saved Location, optionally filtered by the dates on which the records are active.
List Saved Location Insight EventsReturn one page of events that impact a specified PredictHQ Saved Location.
List Saved Location Opening HoursReturn one page of opening-hours records for a Saved Location, optionally filtered by the dates on which the records are active.
List Saved LocationsSearch and return one page of Saved Locations, including reusable location IDs, geographic definitions, enrichment state, and summary insights.
Refresh Beam AnalysisRerun correlation and analysis processing for an existing Beam Analysis.
Refresh Beam Analysis GroupRerun aggregation for an existing Beam Analysis Group.
Replace Beam AnalysisFully replace an existing Beam analysis using PUT.
Replace Beam Analysis GroupFully replace an existing Beam analysis group using PUT.
Replace Forecast ModelFully replace an existing forecast model's mutable configuration.
Replace Loop LinkFully replace the mutable name, expiry, and metadata of an existing PredictHQ Loop Link using PUT.
Replace Saved LocationFully replace an existing PredictHQ Saved Location using PUT.
Replace Saved Location Opening HoursFully replace one PredictHQ Saved Location opening-hours record.
Search BroadcastsReturn one page of US county-level live-TV broadcast records matching event, geography, status, and date filters.
Search EventsSearch for events happening in a location and date range using PredictHQ's event, location, rank, label, attendance, spend, and lifecycle filters.
Search PlacesReturn one page of places matching text, country, coordinates, place IDs, or administrative type filters.
Train Forecast ModelTriggers asynchronous training for a forecast model that has uploaded demand data and is in an eligible readiness state.
Update Beam AnalysisPartially update one or more fields on an existing Beam analysis without replacing fields that are omitted.
Update Beam Analysis GroupPartially update an existing Beam analysis group using PATCH.
Update Forecast ModelPartially update a forecast model.
Upload Beam Analysis DemandUpload daily or weekly demand data to an existing Beam analysis.
Upload Forecast Model DemandUpload historical demand data to an existing forecast model as typed JSON, CSV, or newline-delimited JSON.
Upsert Loop SettingsCreate or replace the organization-wide display name used by the hosted Loop interface.