Features API - Intro and Getting Started
What is the Features API?
The Features API changes the way you’re able to use PredictHQ’s demand intelligence. The API aggregates and makes available core statistics from our underlying event datasets, enabling you to use the features directly in your models, without having to do preparatory work to integrate with us. This will significantly reduce the time taken for you to implement our data, and enables us to better serve you.
What are features?
It’s easy to misunderstand what features are - but it’s really simple in the context of data science, and not to be confused with product features! Features are essentially properties or characteristics from a set of data (e.g. what does the data feature?). This could be a sum, an average, or count of events, across a specific location, or several locations.
What are some examples of features?
There's several features we have available for you to try today, these include, by category:
PHQ Attendance: Count, Min, Max, Average, Median, Sum, Standard Deviation
PHQ Rank: Count (Bucketed at a rank level)
Where can I try it?
As a starting point, we recommend checking out the Features API with PredictHQ’s API explorer available in Control Center: https://control.predicthq.com/explorer/features. You can use your existing API keys.
We have in-depth technical documentation and resources such as Jupyter Notebooks available at our tech docs page here: https://docs.predicthq.com/datascience/features-api/
What’s the cost / licensing?
The Features API is currently offered and available to all premium plans, and is available as per the location access your organization currently has for the events API.
How is this different to the Events API?
Our Events API gives event data, Features API provides statistical data. If you are looking for detailed, granular information about specific events, or need that level of detail, the Events API remains our recommendation for this use case. However, if your demand forecasting requirements are more around understanding patterns, trends, and aggregations at a high level across a location, the Features API provides a powerful tool. We encourage you to try both options and seek the guidance from our data science solutions engineering team to determine the best API for your needs. For many customers, it will be a combination of both.