Data Exporter
The Data Exporter allows customers to export PredictHQ events as CSV or JSON files.
A couple of things to keep in mind:
- The latest version of Chrome, Firefox, Safari or Edge is required.
- Some spreadsheet software has trouble with utf-8 characters so please select utf-8 encoding when importing a CSV file.
Instructions
- Log in to your PredictHQ account or sign up for a Developer Plan if you haven't got an account yet.
- In the API Clients part of Control Center, create a new API Client. Save the Client Secret somewhere as you won't be able to see it again within Control Center. Then click "Create an access token". Select the scopes "Account", "Events" and "Places".
- Open https://exporter.predicthq.com in your preferred browser.
- Click on "Begin" and enter the Access Token you generated.
- Choose the filters and parameters that you wish to export. Refer to the Search Events documentation for a full list of fields and parameters.
- Click "Get data" to begin file download.
CSV Fields
Field |
Description |
---|---|
id string |
The unique identifier of the event. E.g. |
title string |
The title of the event. E.g. |
description string |
A description of the event. E.g. |
start string |
The start date of the event in ISO 8601 format. All start dates are in UTC if the event time zone is provided, and in local time otherwise. For example, Independence Day falls on the 4th of July regardless of the time zone, and will have a blank time zone. If an event has a start time of midnight (in the event time zone) this is an indication that the actual time may be unknown. You may wish to omit the time when displaying these events. E.g. |
end string |
The end date of the event in ISO 8601 format. All end dates are in UTC if the event time zone is provided, and in local time otherwise. For example, Independence Day falls on the 4th of July regardless of the time zone, and will have a blank time zone. E.g. |
predicted_end string |
The predicted end date of the event in ISO 8601 format. Predicted end dates are in UTC if the event time zone is provided, and in local time otherwise. For example, Independence Day falls on the 4th of July regardless of the time zone, and will have a blank time zone. This field will be blank when an actual E.g. |
duration number |
The duration of the event in seconds. E.g. |
labels string |
The labels associated with the event. Use the count endpoint to fetch a list of available labels. E.g. |
category string |
The category of the event Possible values:
E.g. |
timezone string |
The time zone of the event in TZ Database format. This is helpful so you know which time zone to convert the dates to (if needed). If the time zone is blank, the E.g. |
country string |
The country code in ISO 3166-1 alpha 2 format. E.g. |
location string |
Latitude and longitude of the event in the order "lat,lon". E.g. |
venue_name string |
The name of the venue where the event is happening. E.g. |
venue_formatted_address string |
The address of the venue where the event is happening. Note the address will usually be on multiple lines. E.g. |
scope string |
The geographical scope the events apply to. Possible values:
E.g. |
rank number |
PHQ Rank. A log scale numerical value between 0 and 100 with a five-level hierarchical impact schema. It is designed to represent the potential impact of an event independent of its geographical location. E.g. |
local_rank number |
Similar to PHQ Rank, this is a log scale numerical value between 0 and 100 with a five-level hierarchical impact schema. It is designed to represent the potential impact of an event on its local geographical area. Local Rank is calculated for events in the categories If E.g. |
aviation_rank number |
A log scale numerical value between 0 and 100 with a five-level hierarchical impact schema. Aviation Rank indicates how much an event will impact flight bookings by considering both domestic and international travel. It can be mapped to the predicted increase in demand based on people flying to an event. Therefore, events with higher Aviation Rank are expected to result in more people taking flights than lower Aviation Rank events. Aviation Rank is calculated for events in the categories If E.g. |
phq_attendance number |
A numerical value that reflects the predicted attendance number. E.g. |
state string |
The publication state of the event. Possible values:
|
deleted_reason string |
The reason why the event was deleted. Note that this field is only present for events with state Possible values:
E.g. |
first_seen string |
The date the event first entered our dataset in ISO 8601 format. All dates are in UTC. This value may be blank on some events, and should not be considered an event announcement date. E.g. |