Data Exporter

The Data Exporter allows Data Licence customers to export PredictHQ events as CSV or JSON files.

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.

Available for Data Licence Customers Only

The Data Exporter can only be used by Data Licence customers whose plans allow data storage and analysis (check your plan details in the Developers section of the PredictHQ Web App).

Instructions

  • Log in to your PredictHQ account or sign up if you haven't got an account yet.
  • In the Developers section of the Web App, create a new Application. Save the Client Secret somewhere as you won't be able to see it again within the Web App. Then click "Generate 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. eBZarD9oGNea

title string

The title of the event.

E.g. Katy Perry with Carly Rae Jepsen

description string

A description of the event.

E.g. Katy Perry and Carly Rae Jepsen performing their hit songs at Gila River Arena

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 null 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. 2018-01-20T02:30:00Z

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 null time zone.

E.g. 2018-01-20T04:30:00Z

duration number

The duration of the event in seconds.

E.g. 7200

labels string

The labels associated with the event. Use the count endpoint to fetch a list of available labels.

E.g. "concerts,music"

category string

The category of the event

Possible values:

  • school-holidays
  • public-holidays
  • observances
  • politics
  • conferences
  • expos
  • concerts
  • festivals
  • performing-arts
  • sports
  • community
  • daylight-savings
  • airport-delays
  • severe-weather
  • disasters
  • terror

E.g. concerts

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 null, the start and end date should be regarded as time zone agnostic and already being in local time. Our start and end filters take this into account when specifying a lower and higher bound on dates.

E.g. America/Phoenix

country string

The country code in ISO 3166-1 alpha 2 format.

E.g. US

location string

Latitude and longitude of the event in the order "lat,lon".

E.g. "33.531937,-112.261187"

venue_name string

The name of the venue where the event is happening.

E.g. Gila River Arena

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. 9400 West Maryland Avenue↵Glendale, AZ 85305↵United States of America

scope string

The geographical scope the events apply to.

Possible values:

  • locality
  • county
  • region
  • country

E.g. locality

rank number

A number between 0 and 100 representing the estimated impact of the event.

E.g. 75

local_rank number

A number between 0 and 100 representing the estimated local impact of the event. This is designed to be more representative of the event’s local impact by taking into account population density to adjust the estimated event impact according to the surrounding geographic area.

local_rank is calculated for events in the categories community, concerts, conferences, expos, sports, festivals, performing-arts. If local_rank is not intended to be available for an event, this field will be null.

E.g. 97

state string

The publication state of the event.

Possible values:

  • active: the event is published and valid.
  • deleted: the event was removed, either because it was cancelled or is a duplicate.

first_seen string

The date the event first entered our dataset in ISO 8601 format. All dates are in UTC. This value may be missing on some events, and should not be considered an event announcement date.

E.g. 2017-05-16T18:01:32Z