NDJSON Data Structure for ADX
Data can be provided as NDJSON, CSV or Parquet. This document describes the NDJSON data structure.
Last updated
Was this helpful?
Data can be provided as NDJSON, CSV or Parquet. This document describes the NDJSON data structure.
Last updated
Was this helpful?
© 2024 PredictHQ Ltd
Field | Description |
---|---|
id
The unique identifier of the event.
parent_event
Used to indicate if this event is part of a larger event. These types of events are called umbrella events in the system. For example, a large multi-day parent umbrella event may have individual child events for sessions on different days. This field only shows if a child event has a parent id. It does not indicate if a parent event has child events. For details see our Umbrella Events docs.
title
The title of the event.
description
The description of the event.
category
The category of the event.
labels
The labels associated with the event. Use the count endpoint to fetch a list of available labels.
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.
See also our PHQ Rank docs.
local_rank
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 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
.
See also our Local Rank docs.
aviation_rank
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 concerts, conferences, expos, sports, festivals, performing-arts, observances, public-holidays, and school-holidays. If aviation_rank is not intended to be available for an event or we couldn't calculate it, this field will be null.
See also our Aviation Rank docs.
phq_attendance
phq_attendance
reflects the entire attendance for multi-day events (the number of people attending across the full duration of the event) except for some categories like conferences where it is the daily attendance.
For details see our Predicted Attendance guide.
entities
An array of entities linked to the event. This is a complex data type, please see Events API for details.
duration
Not directly corresponding to a previous field, but relates to the difference in seconds between EVENT_START and EVENT_END.
start
The date and time that the event starts in UTC.
end
The date and time that the event ends in UTC.
updated
The date and time the event was last updated in UTC.
first_seen
The date and time the event was first seen by PredictHQ in UTC.
timezone
The time zone of the event in TZ Database format.
location
This field seems to provide geographic coordinates derived from GEO.
geo
The geographic details (location) of the event in GeoJSON format.
impact_patterns
Also known as “Demand impact patterns”. This field shows impact for leading days (days before the event), lagging days (days after an event) and the days the event occurs. It contains details such as the industry vertical the impact pattern applies to, the type of impact shown in the impact pattern, and an array of objects for each day showing the date in the local timezone of the event and the value of the impact_type for that given day.
scope
The geographical scope the events apply to.
placekey
The Placekey identifier for the physical address where the event takes place. See Placekey. This field will be null
if the What part or the Where part of the Placekey for the event address couldn't be retrieved.
country
The country code in ISO 3166-1 alpha-2 format.
place_hierarchies
An array of place hierarchies for the event. Each hierarchy is an array of place ids. The final place in a hierarchy is a specific place the event applies to. Each place is a sub-place of the place immediately preceding it in the hierarchy. An empty array is possible and valid.
See also the Place Hierarchies guide.
state
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.
brand_safe
Whether or not this event is considered brand-safe. Examples of brand-unsafe events include content that promotes hate, violence, or discrimination, coarse language, content that is sexually suggestive or explicit, etc.
cancelled
The date and time the event was set to cancelled in UTC.
postponed
The date and time the event was set to postponed in UTC.
predicted_event_spend_industries
An object containing predicted event spend for various industries like accommodation, hospitality, and transportation. See Events API docs.
phq_labels
The PHQ Labels associated with the event. This field will be null
if there are no PHQ Labels for this event.
predicted_end
The date and time that PredictHQ predicts that the physical event being broadcast will end, in the timezone of the event.
alternate_ids
All alternate IDs for the event. Any event IDs that may have been used for this event in the past will be included here. It does not include the current event ID.
change_action
Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.
UPDATE
DELETE
INSERT