From ecb5aa892494e0720076a9e49e049134d5472f3b Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Wed, 30 Jul 2025 13:59:27 +1200 Subject: [PATCH 1/2] Report Local Rank always available --- .../event-categories/attendance-based-events.md | 2 +- .../event-categories/non-attendance-based-events.md | 12 ++++++------ .../event-categories/unscheduled-events.md | 10 +++++----- .../predicthq-data/ranks/local-rank.md | 1 - .../csv-parquet-data-structure-for-adx.md | 2 +- .../ndjson-data-structure-for-adx.md | 2 +- 6 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/tech-docs/getting-started/predicthq-data/event-categories/attendance-based-events.md b/docs/tech-docs/getting-started/predicthq-data/event-categories/attendance-based-events.md index 24c1171..7b3d465 100644 --- a/docs/tech-docs/getting-started/predicthq-data/event-categories/attendance-based-events.md +++ b/docs/tech-docs/getting-started/predicthq-data/event-categories/attendance-based-events.md @@ -396,7 +396,7 @@ Academic events have PHQ Rank available. **Local Rank** -Academic events have no Local Rank available. +Academic events have Local Rank available. **PHQ Attendance** diff --git a/docs/tech-docs/getting-started/predicthq-data/event-categories/non-attendance-based-events.md b/docs/tech-docs/getting-started/predicthq-data/event-categories/non-attendance-based-events.md index 1fdac44..2336b06 100644 --- a/docs/tech-docs/getting-started/predicthq-data/event-categories/non-attendance-based-events.md +++ b/docs/tech-docs/getting-started/predicthq-data/event-categories/non-attendance-based-events.md @@ -47,7 +47,7 @@ Public holidays have event group entities available. **Local Rank** -Public holidays events have no Local Rank available as they impact an entire area instead of a specific point +Public holidays events have Local Rank available. **PHQ Attendance** @@ -183,9 +183,9 @@ All school holidays for other countries and from the US and UK before the time p **Local Rank** -For the United Kingdom (from September 2017) and US (from September 2018) school holidays, local rank is calculated by applying a linear transformation to the student percentage of the local authority. The student percentage is calculated by dividing the student numbers of a local authority by its total population. +School holidays events have Local Rank available. -School holidays events for other countries, and from the US and UK before the time periods stated above, have no Local Rank available as they do not have student numbers attached. +For the United Kingdom (from September 2017) and US (from September 2018) school holidays, local rank is calculated by applying a linear transformation to the student percentage of the local authority. The student percentage is calculated by dividing the student numbers of a local authority by its total population. **PHQ Attendance** @@ -236,7 +236,7 @@ Observances have event group entities available. **Local Rank** -Observance events have no Local Rank available as they impact an entire area instead of a specific point. +Observance events have Local Rank available. **PHQ Attendance** @@ -277,7 +277,7 @@ Politics events have PHQ Rank available. It considers the number of registered v **Local Rank** -Politics events have no Local Rank available as they impact an entire country instead of a specific point. +Politics events have Local Rank available. **PHQ Attendance** @@ -313,7 +313,7 @@ All daylight savings events have a PHQ Rank of 30. **Local Rank** -Daylight savings events have no Local Rank available as they impact an entire area. +Daylight savings events have Local Rank available. **PHQ Attendance** diff --git a/docs/tech-docs/getting-started/predicthq-data/event-categories/unscheduled-events.md b/docs/tech-docs/getting-started/predicthq-data/event-categories/unscheduled-events.md index 13db3e8..dc045f2 100644 --- a/docs/tech-docs/getting-started/predicthq-data/event-categories/unscheduled-events.md +++ b/docs/tech-docs/getting-started/predicthq-data/event-categories/unscheduled-events.md @@ -66,7 +66,7 @@ For example, An event with an urgency of immediate (15), a severity of severe (3 **Local Rank** -Severe weather events have no Local Rank available as they impact an entire area instead of a specific point. +Severe weather events have Local Rank available, **PHQ Attendance** @@ -119,7 +119,7 @@ Disaster events have PHQ Rank available, which indicates the severity of the dis **Local Rank** -Disaster events have no Local Rank available as they impact an entire area instead of a specific point. +Disaster events have Local Rank available. **PHQ Attendance** @@ -160,7 +160,7 @@ Airport delays events have PHQ Rank available, indicating the severity of the de **Local Rank** -Airport delays events have no Local Rank available as they impact an entire area instead of a specific point. To be specific, the fact of the flight delay happens in an airport, but the impact is applying to a region where the passengers are from. +Airport delays events have Local Rank available. **PHQ Attendance** @@ -219,7 +219,7 @@ Health warnings events have PHQ Rank available. **Local Rank** -Health warnings events have no Local Rank available as they impact an entire area instead of a specific point. +Health warnings events have Local Rank available. **PHQ Attendance** @@ -263,7 +263,7 @@ Terror events have PHQ Rank available. It indicates the severity of the terroris **Local Rank** -Terror events have no Local Rank available as they impact an entire area instead of a specific point. To be specific, the terrorism acts may happen at a specific location, but the impact is applying to all residents in the nearby area. +Terror events have Local Rank available. **PHQ Attendance** diff --git a/docs/tech-docs/getting-started/predicthq-data/ranks/local-rank.md b/docs/tech-docs/getting-started/predicthq-data/ranks/local-rank.md index bd9a90e..5d11844 100644 --- a/docs/tech-docs/getting-started/predicthq-data/ranks/local-rank.md +++ b/docs/tech-docs/getting-started/predicthq-data/ranks/local-rank.md @@ -3,4 +3,3 @@ Local Rank is a numeric value on a logarithmic scale between 0 and 100 to represent the impact of an event to its local area. Local Rank may vary even though the PHQ Rank of the events are the same. For example, a conference with 1,000 people in attendance (with PHQ Rank 50) has a [Local Rank of 43 in Hong Kong](https://events.predicthq.com/events/KKtBoCYP3gWPvgGhnp) where the local population density is around 64,000, while a [Local Rank of 65 in Dublin, Ireland](https://events.predicthq.com/events/0lrweBnDZKrr) where the local population density is around 5,000. * Local Rank is comparable between the attended events in terms of the event’s impact to its local area. -* Local Rank is not available for area events, the field returns `null`. diff --git a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md index d62f2d5..cf272af 100644 --- a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md +++ b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md @@ -6,4 +6,4 @@ description: >- # CSV/Parquet Data Structure for ADX -
FieldDescription
EVENT_IDThe unique identifier of the event.
CREATE_DTThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
UPDATE_DTThe date and time the event was last updated in UTC.
TITLEThe title of the event.
CATEGORYThe category of the event.
LABELSThe labels associated with the event. The LABELS field is representing PredictHQ's legacy labels, and it's suggested to use the PHQ_LABELS field instead where possible.

See also our Labels docs.
DESCRIPTIONThe description of the event.
EVENT_START

The date and time the event starts, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events.

EVENT_ENDThe date and time the event ends, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.
PREDICTED_ENDThe date and time PredictHQ predicts the event will end, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones. This value is present where an actual EVENT_END is unknown.
TIMEZONEThe 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.
ENTITIESAn array of entities linked to the event. This is a complex data type, please see Events API for details.
GEOThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling GEO data.
IMPACT_PATTERNSAlso known as “Predicted 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.

See also our Impact Patterns docs.
SCOPE

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
PLACEKEYThe 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_CODEThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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.

PHQ_ATTENDANCE

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

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.

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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

STATUS

The publication state of the event.

Possible values:

  • active - The event is an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
BRAND_SAFEWhether 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.
PARENT_EVENT_IDUsed 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.
CANCELLED_DTThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if STATUS is not set to "cancelled" or if the cancellation date is unavailable.
POSTPONED_DTThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if STATUS is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
PREDICTED_EVENT_SPEND_TOTALThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_ACCOMMODATIONThe total predicted event spend (USD) for the accommodation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_HOSPITALITYThe total predicted event spend (USD) for the hospitality industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_TRANSPORTATIONThe total predicted event spend for the transportation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PHQ_LABELSThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
ALTERNATE_IDSAll 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.
EVENT_START_LOCALThe date and time when the event begins, expressed in the event's local time zone.
EVENT_END_LOCALThe date and time when the event ends, expressed in the event's local time zone.
PREDICTED_END_LOCALThe date and time when the event is predicted to end, expressed in the event's local time zone.
REGIONThe region in which the event will be occurring. This field will be null if the event covers more than a single region.
LOCALITYThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field will be null if the event covers more than a single locality.
POSTCODEThe postal code or ZIP code in which the event will be occurring. This field will be null if the event covers more than a single post code.
FORMATTED_ADDRESSA full formatted address which can include street addresses, locality, postcode, region, and country.
ROW_INSERTED_DTThe date and time this row was inserted in UTC. The row may have been deleted and inserted multiple times so it does not reflect when an event is first seen, use CREATE_DT for that.
ROW_UPDATED_DTThe date and time this row was last updated in UTC.
CHANGE_ACTION

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.
+
FieldDescription
EVENT_IDThe unique identifier of the event.
CREATE_DTThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
UPDATE_DTThe date and time the event was last updated in UTC.
TITLEThe title of the event.
CATEGORYThe category of the event.
LABELSThe labels associated with the event. The LABELS field is representing PredictHQ's legacy labels, and it's suggested to use the PHQ_LABELS field instead where possible.

See also our Labels docs.
DESCRIPTIONThe description of the event.
EVENT_START

The date and time the event starts, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events.

EVENT_ENDThe date and time the event ends, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.
PREDICTED_ENDThe date and time PredictHQ predicts the event will end, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones. This value is present where an actual EVENT_END is unknown.
TIMEZONEThe 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.
ENTITIESAn array of entities linked to the event. This is a complex data type, please see Events API for details.
GEOThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling GEO data.
IMPACT_PATTERNSAlso known as “Predicted 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.

See also our Impact Patterns docs.
SCOPE

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
PLACEKEYThe 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_CODEThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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.

PHQ_ATTENDANCE

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

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.

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.

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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

STATUS

The publication state of the event.

Possible values:

  • active - The event is an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
BRAND_SAFEWhether 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.
PARENT_EVENT_IDUsed 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.
CANCELLED_DTThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if STATUS is not set to "cancelled" or if the cancellation date is unavailable.
POSTPONED_DTThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if STATUS is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
PREDICTED_EVENT_SPEND_TOTALThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_ACCOMMODATIONThe total predicted event spend (USD) for the accommodation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_HOSPITALITYThe total predicted event spend (USD) for the hospitality industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_TRANSPORTATIONThe total predicted event spend for the transportation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PHQ_LABELSThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
ALTERNATE_IDSAll 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.
EVENT_START_LOCALThe date and time when the event begins, expressed in the event's local time zone.
EVENT_END_LOCALThe date and time when the event ends, expressed in the event's local time zone.
PREDICTED_END_LOCALThe date and time when the event is predicted to end, expressed in the event's local time zone.
REGIONThe region in which the event will be occurring. This field will be null if the event covers more than a single region.
LOCALITYThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field will be null if the event covers more than a single locality.
POSTCODEThe postal code or ZIP code in which the event will be occurring. This field will be null if the event covers more than a single post code.
FORMATTED_ADDRESSA full formatted address which can include street addresses, locality, postcode, region, and country.
ROW_INSERTED_DTThe date and time this row was inserted in UTC. The row may have been deleted and inserted multiple times so it does not reflect when an event is first seen, use CREATE_DT for that.
ROW_UPDATED_DTThe date and time this row was last updated in UTC.
CHANGE_ACTION

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.
diff --git a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md index 55958d2..b7b2cf1 100644 --- a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md +++ b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md @@ -6,4 +6,4 @@ description: >- # NDJSON Data Structure for ADX -
FieldDescription
idThe unique identifier of the event.
parent_eventUsed 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.
titleThe title of the event.
descriptionThe description of the event.
categoryThe category of the event.
labelsThe labels associated with the event. The labels field is representing PredictHQ's legacy labels, and it's suggested to use the phq_labels field instead where possible.

See also our Labels docs.
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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

phq_attendance

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

entitiesAn array of entities linked to the event. This is a complex data type, please see Events API for details.
durationThe difference in seconds between the event start and the event end.
start

The date and time the event starts, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events

endThe date and time the event ends, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.
updatedThe date and time the event was last updated in UTC.
first_seenThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
timezoneThe 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.
geoThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling geo data.
impact_patternsAlso known as “Predicted 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.

See also our Impact Patterns docs.
scope

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
placekeyThe 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.
countryThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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 an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
brand_safeWhether 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.
cancelledThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if state is not set to "cancelled" or if the cancellation date is unavailable.
postponedThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if state is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
predicted_event_spendThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
predicted_event_spend_industriesA breakdown of predicted event spend (USD) into the three supported industries: accommodation, hospitality, and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
phq_labelsThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
predicted_endThe date and time PredictHQ predicts the event will end, recorded in UTC. If the timezone field is null, the time represents the same relative time across all timezones. This value is present where an actual timezone is unknown.
alternate_idsAll 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.
start_localThe date and time when the event begins, expressed in the event's local time zone.
end_localThe date and time when the event ends, expressed in the event's local time zone.
predicted_end_localThe date and time when the event is predicted to end, expressed in the event's local time zone.
regionThe region in which the event will be occurring. This field can be null if the event covers more than a single region.
localityThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field can be null if the event covers more than a single locality.
postcodeThe postal code or ZIP code in which the event will be occurring. This field can be null if the event covers more than a single post code.
formatted_addressA full formatted address which can include street addresses, locality, postcode, region, and country.
change_action

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.
+
FieldDescription
idThe unique identifier of the event.
parent_eventUsed 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.
titleThe title of the event.
descriptionThe description of the event.
categoryThe category of the event.
labelsThe labels associated with the event. The labels field is representing PredictHQ's legacy labels, and it's suggested to use the phq_labels field instead where possible.

See also our Labels docs.
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.

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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

phq_attendance

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

entitiesAn array of entities linked to the event. This is a complex data type, please see Events API for details.
durationThe difference in seconds between the event start and the event end.
start

The date and time the event starts, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events

endThe date and time the event ends, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.
updatedThe date and time the event was last updated in UTC.
first_seenThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
timezoneThe 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.
geoThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling geo data.
impact_patternsAlso known as “Predicted 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.

See also our Impact Patterns docs.
scope

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
placekeyThe 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.
countryThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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 an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
brand_safeWhether 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.
cancelledThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if state is not set to "cancelled" or if the cancellation date is unavailable.
postponedThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if state is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
predicted_event_spendThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
predicted_event_spend_industriesA breakdown of predicted event spend (USD) into the three supported industries: accommodation, hospitality, and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
phq_labelsThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
predicted_endThe date and time PredictHQ predicts the event will end, recorded in UTC. If the timezone field is null, the time represents the same relative time across all timezones. This value is present where an actual timezone is unknown.
alternate_idsAll 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.
start_localThe date and time when the event begins, expressed in the event's local time zone.
end_localThe date and time when the event ends, expressed in the event's local time zone.
predicted_end_localThe date and time when the event is predicted to end, expressed in the event's local time zone.
regionThe region in which the event will be occurring. This field can be null if the event covers more than a single region.
localityThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field can be null if the event covers more than a single locality.
postcodeThe postal code or ZIP code in which the event will be occurring. This field can be null if the event covers more than a single post code.
formatted_addressA full formatted address which can include street addresses, locality, postcode, region, and country.
change_action

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.
From 0d0d78a5e7cb03b45225fde46d90e78204286086 Mon Sep 17 00:00:00 2001 From: Paul Duncan Date: Wed, 30 Jul 2025 14:19:00 +1200 Subject: [PATCH 2/2] aws integration local rank references fix --- .../aws-data-exchange/csv-parquet-data-structure-for-adx.md | 2 +- .../aws-data-exchange/ndjson-data-structure-for-adx.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md index cf272af..f8628c0 100644 --- a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md +++ b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/csv-parquet-data-structure-for-adx.md @@ -6,4 +6,4 @@ description: >- # CSV/Parquet Data Structure for ADX -
FieldDescription
EVENT_IDThe unique identifier of the event.
CREATE_DTThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
UPDATE_DTThe date and time the event was last updated in UTC.
TITLEThe title of the event.
CATEGORYThe category of the event.
LABELSThe labels associated with the event. The LABELS field is representing PredictHQ's legacy labels, and it's suggested to use the PHQ_LABELS field instead where possible.

See also our Labels docs.
DESCRIPTIONThe description of the event.
EVENT_START

The date and time the event starts, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events.

EVENT_ENDThe date and time the event ends, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.
PREDICTED_ENDThe date and time PredictHQ predicts the event will end, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones. This value is present where an actual EVENT_END is unknown.
TIMEZONEThe 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.
ENTITIESAn array of entities linked to the event. This is a complex data type, please see Events API for details.
GEOThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling GEO data.
IMPACT_PATTERNSAlso known as “Predicted 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.

See also our Impact Patterns docs.
SCOPE

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
PLACEKEYThe 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_CODEThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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.

PHQ_ATTENDANCE

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

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.

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.

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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

STATUS

The publication state of the event.

Possible values:

  • active - The event is an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
BRAND_SAFEWhether 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.
PARENT_EVENT_IDUsed 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.
CANCELLED_DTThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if STATUS is not set to "cancelled" or if the cancellation date is unavailable.
POSTPONED_DTThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if STATUS is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
PREDICTED_EVENT_SPEND_TOTALThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_ACCOMMODATIONThe total predicted event spend (USD) for the accommodation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_HOSPITALITYThe total predicted event spend (USD) for the hospitality industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_TRANSPORTATIONThe total predicted event spend for the transportation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PHQ_LABELSThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
ALTERNATE_IDSAll 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.
EVENT_START_LOCALThe date and time when the event begins, expressed in the event's local time zone.
EVENT_END_LOCALThe date and time when the event ends, expressed in the event's local time zone.
PREDICTED_END_LOCALThe date and time when the event is predicted to end, expressed in the event's local time zone.
REGIONThe region in which the event will be occurring. This field will be null if the event covers more than a single region.
LOCALITYThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field will be null if the event covers more than a single locality.
POSTCODEThe postal code or ZIP code in which the event will be occurring. This field will be null if the event covers more than a single post code.
FORMATTED_ADDRESSA full formatted address which can include street addresses, locality, postcode, region, and country.
ROW_INSERTED_DTThe date and time this row was inserted in UTC. The row may have been deleted and inserted multiple times so it does not reflect when an event is first seen, use CREATE_DT for that.
ROW_UPDATED_DTThe date and time this row was last updated in UTC.
CHANGE_ACTION

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.
+
FieldDescription
EVENT_IDThe unique identifier of the event.
CREATE_DTThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
UPDATE_DTThe date and time the event was last updated in UTC.
TITLEThe title of the event.
CATEGORYThe category of the event.
LABELSThe labels associated with the event. The LABELS field is representing PredictHQ's legacy labels, and it's suggested to use the PHQ_LABELS field instead where possible.

See also our Labels docs.
DESCRIPTIONThe description of the event.
EVENT_START

The date and time the event starts, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events.

EVENT_ENDThe date and time the event ends, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones.
PREDICTED_ENDThe date and time PredictHQ predicts the event will end, recorded in UTC. If the TIMEZONE field is null, the time represents the same relative time across all timezones. This value is present where an actual EVENT_END is unknown.
TIMEZONEThe 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.
ENTITIESAn array of entities linked to the event. This is a complex data type, please see Events API for details.
GEOThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling GEO data.
IMPACT_PATTERNSAlso known as “Predicted 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.

See also our Impact Patterns docs.
SCOPE

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
PLACEKEYThe 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_CODEThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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.

PHQ_ATTENDANCE

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

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.

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 all events.

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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

STATUS

The publication state of the event.

Possible values:

  • active - The event is an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
BRAND_SAFEWhether 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.
PARENT_EVENT_IDUsed 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.
CANCELLED_DTThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if STATUS is not set to "cancelled" or if the cancellation date is unavailable.
POSTPONED_DTThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if STATUS is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
PREDICTED_EVENT_SPEND_TOTALThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_ACCOMMODATIONThe total predicted event spend (USD) for the accommodation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_HOSPITALITYThe total predicted event spend (USD) for the hospitality industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PREDICTED_EVENT_SPEND_TRANSPORTATIONThe total predicted event spend for the transportation industry. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
PHQ_LABELSThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
ALTERNATE_IDSAll 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.
EVENT_START_LOCALThe date and time when the event begins, expressed in the event's local time zone.
EVENT_END_LOCALThe date and time when the event ends, expressed in the event's local time zone.
PREDICTED_END_LOCALThe date and time when the event is predicted to end, expressed in the event's local time zone.
REGIONThe region in which the event will be occurring. This field will be null if the event covers more than a single region.
LOCALITYThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field will be null if the event covers more than a single locality.
POSTCODEThe postal code or ZIP code in which the event will be occurring. This field will be null if the event covers more than a single post code.
FORMATTED_ADDRESSA full formatted address which can include street addresses, locality, postcode, region, and country.
ROW_INSERTED_DTThe date and time this row was inserted in UTC. The row may have been deleted and inserted multiple times so it does not reflect when an event is first seen, use CREATE_DT for that.
ROW_UPDATED_DTThe date and time this row was last updated in UTC.
CHANGE_ACTION

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.
diff --git a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md index b7b2cf1..9124281 100644 --- a/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md +++ b/docs/tech-docs/integrations/third-party-integrations/aws-data-exchange/ndjson-data-structure-for-adx.md @@ -6,4 +6,4 @@ description: >- # NDJSON Data Structure for ADX -
FieldDescription
idThe unique identifier of the event.
parent_eventUsed 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.
titleThe title of the event.
descriptionThe description of the event.
categoryThe category of the event.
labelsThe labels associated with the event. The labels field is representing PredictHQ's legacy labels, and it's suggested to use the phq_labels field instead where possible.

See also our Labels docs.
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.

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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

phq_attendance

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

entitiesAn array of entities linked to the event. This is a complex data type, please see Events API for details.
durationThe difference in seconds between the event start and the event end.
start

The date and time the event starts, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events

endThe date and time the event ends, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.
updatedThe date and time the event was last updated in UTC.
first_seenThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
timezoneThe 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.
geoThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling geo data.
impact_patternsAlso known as “Predicted 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.

See also our Impact Patterns docs.
scope

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
placekeyThe 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.
countryThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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 an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
brand_safeWhether 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.
cancelledThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if state is not set to "cancelled" or if the cancellation date is unavailable.
postponedThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if state is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
predicted_event_spendThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
predicted_event_spend_industriesA breakdown of predicted event spend (USD) into the three supported industries: accommodation, hospitality, and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
phq_labelsThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
predicted_endThe date and time PredictHQ predicts the event will end, recorded in UTC. If the timezone field is null, the time represents the same relative time across all timezones. This value is present where an actual timezone is unknown.
alternate_idsAll 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.
start_localThe date and time when the event begins, expressed in the event's local time zone.
end_localThe date and time when the event ends, expressed in the event's local time zone.
predicted_end_localThe date and time when the event is predicted to end, expressed in the event's local time zone.
regionThe region in which the event will be occurring. This field can be null if the event covers more than a single region.
localityThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field can be null if the event covers more than a single locality.
postcodeThe postal code or ZIP code in which the event will be occurring. This field can be null if the event covers more than a single post code.
formatted_addressA full formatted address which can include street addresses, locality, postcode, region, and country.
change_action

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.
+
FieldDescription
idThe unique identifier of the event.
parent_eventUsed 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.
titleThe title of the event.
descriptionThe description of the event.
categoryThe category of the event.
labelsThe labels associated with the event. The labels field is representing PredictHQ's legacy labels, and it's suggested to use the phq_labels field instead where possible.

See also our Labels docs.
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 all events.

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.

Aviation Rank is no longer actively supported. For more information, see the Aviation Rank docs.

phq_attendance

A numerical value that reflects the predicted attendance for supported attendance-based categories. Supported categories include concerts, performing arts, sports, expos, conferences, community, and festivals. Some academic and school holiday events may also include a phq_attendance value to indicate student numbers.

For multi-day events, phq_attendance represents total attendance across the entire duration, except for certain categories like conferences, where it reflects daily attendance.

For details see our Predicted Attendance guide.

entitiesAn array of entities linked to the event. This is a complex data type, please see Events API for details.
durationThe difference in seconds between the event start and the event end.
start

The date and time the event starts, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.

Additionally, if an event has a start time of midnight in its local timezone, this may indicate that the actual time is unknown. You may wish to omit the time when displaying such events

endThe date and time the event ends, recorded in UTC. If the timezone is not considered relevant (e.g., Independence Day), the time is stored in UTC to represent the same relative time across all timezones, and the timezone field will be null.
updatedThe date and time the event was last updated in UTC.
first_seenThe date and time the event was first seen by PredictHQ in UTC. Also called first_seen in the Events API.
timezoneThe 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.
geoThe geographic details (location) of the event in GeoJSON format.

See geolocation guides for more information on handling geo data.
impact_patternsAlso known as “Predicted 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.

See also our Impact Patterns docs.
scope

The geographical scope the events apply to. Possible values are:

  • locality
  • localadmin
  • county
  • region
  • country
placekeyThe 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.
countryThe country code in ISO 3166-1 alpha 2 format. This value is typically present, but in some cases such as events occurring outside any country (e.g. an earthquake in the middle of the ocean), it may be empty.
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 an active event.
  • postponed - The event is a postponed event, and is expected to occur at a later date.
  • cancelled - The event is a cancelled event and is not expected to occur at a later date.
  • predicted - The event is a predicted event. For details, see our Predicted Events page.
brand_safeWhether 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.
cancelledThe date and time the event was marked as cancelled, presented in the UTC timezone. This field will be null if state is not set to "cancelled" or if the cancellation date is unavailable.
postponedThe date and time the event was marked as postponed, presented in the UTC timezone. This field will be null if state is not set to "postponed" or if the postponement date is unavailable. Note that this field does not represent the new date and time of the postponed event.
predicted_event_spendThe total predicted event spend (USD) across all supported industries: accommodation, hospitality and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
predicted_event_spend_industriesA breakdown of predicted event spend (USD) into the three supported industries: accommodation, hospitality, and transportation. This field will be null if the predicted event spend is not supported for this event.

See also our Predicted Event Spend docs.
phq_labelsThe PHQ Labels associated with the event. This field will be null if there are no PHQ Labels for this event.

See also our Labels docs.
predicted_endThe date and time PredictHQ predicts the event will end, recorded in UTC. If the timezone field is null, the time represents the same relative time across all timezones. This value is present where an actual timezone is unknown.
alternate_idsAll 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.
start_localThe date and time when the event begins, expressed in the event's local time zone.
end_localThe date and time when the event ends, expressed in the event's local time zone.
predicted_end_localThe date and time when the event is predicted to end, expressed in the event's local time zone.
regionThe region in which the event will be occurring. This field can be null if the event covers more than a single region.
localityThe locality in which the event will be occurring. A locality is most commonly referred to as a city or town. This field can be null if the event covers more than a single locality.
postcodeThe postal code or ZIP code in which the event will be occurring. This field can be null if the event covers more than a single post code.
formatted_addressA full formatted address which can include street addresses, locality, postcode, region, and country.
change_action

Indicates if the record has been updated, deleted or inserted. Use when processing the data file to keep your database updated.

Possible values:

  • insert - new record, not previously seen.
  • update - existing record, updated values.
  • delete - deleted record, remove from your dataset.