Get Event Counts

Get the count of events by category, PHQ Label and more.

Get Event Counts

get

Get the count of events by category, PHQ Label and more. The Count endpoint supports the same query parameters as the Search Events endpoint.

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Query parameters

active.gtestring · date-timeOptional

Filters events that are active on or after the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

active.gtstring · date-timeOptional

Filters events that are active after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

active.ltestring · date-timeOptional

Filters events that are active on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

active.ltstring · date-timeOptional

Filters events that are active before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

active.tzstringOptional

Specifies the timezone for the active.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

beam.analysis_idstringOptional

An optional Beam Analysis filter which if provided will calculate the location, rank and categories from the Beam Analysis and optionally the Beam Analysis group (see beam.group_id).

This is the best way to filter for events relevant to your business based on your Beam Analysis.

beam.group_idstringOptional

If beam.group_id is provided the categories will be calculated from the feature importance results of the Analysis Group otherwise the categories will be calculated from the feature importance results of the individual Analysis.

If using beam.group_id the beam.analysis_id is required.

brand_unsafe.excludestring · enumOptional

Whether or not to exclude potentially brand-unsafe events. Potentially brand-unsafe events are included by default.

Examples of brand-unsafe events include content that promotes hate, violence or discrimination, coarse language, content that is sexually suggestive or explicit, etc.

Default: false

Possible values:

cancelled.gtestring · date-timeOptional

Filters events that were cancelled on or after the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

cancelled.gtstring · date-timeOptional

Filters events that were cancelled after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

cancelled.ltestring · date-timeOptional

Filters events that were cancelled on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

cancelled.ltstring · date-timeOptional

Filters events that were cancelled before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

cancelled.tzstringOptional

Specifies the timezone for the cancelled.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

countrystring[]Optional

A comma-separated list of 2-letter country codes.

Example: US

end.gtestring · date-timeOptional

Filters events that end on or after the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

end.gtstring · date-timeOptional

Filters events that end after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

end.ltestring · date-timeOptional

Filters events that end on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

end.ltstring · date-timeOptional

Filters events that end before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

end.tzstringOptional

Specifies the timezone for the end.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

entity.idstring[]Optional

A comma-separated list of Entity identifiers.

Example: XABWvihQAj8TnjvF6WNzLW

first_seen.gtestring · date-timeOptional

Filters events that were first seen in our system on or after the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

first_seen.gtstring · date-timeOptional

Filters events that were first seen in our system after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

first_seen.ltestring · date-timeOptional

Filters events that were first seen in our system on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

first_seen.ltstring · date-timeOptional

Filters events that were first seen in our system before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

first_seen.tzstringOptional

Specifies the timezone for the first_seen.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

idstring[]Optional

A comma-separated list of Event identifiers.

Example: z13B3870YOgv

impact.gtestring · date-timeOptional

Filters events that are predicted to have an impact on or after the specified date.

The Predicted Impact Pattern of events can be larger than the actual event date range.

These parameters work similarly to the active.* parameter, but it uses an industry-specific Predicted Impact Pattern date range of an event where applicable.

You must also specify the industry (see impact.industry).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

impact.gtstring · date-timeOptional

Filters events that are predicted to have an impact after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

impact.ltestring · date-timeOptional

Filters events that are predicted to have an impact on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

impact.ltstring · date-timeOptional

Filters events that are predicted to have an impact before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

impact.tzstringOptional

Specifies the timezone for the impact.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

impact.industrystring · enumOptional

Selected industry for the Predicted Impact Patterns.

If no industry is selected, impact.* will function effectively the same as active.*.

Example: accommodation

Possible values:

local_rank.gteinteger · max: 100Optional

Filters events with a Local Rank greater than or equal to the specified value.

Events without a Local Rank will not be returned.

Example: 80

local_rank.gtinteger · max: 100Optional

Filters events with a Local Rank greater than the specified value.

Events without a Local Rank will not be returned.

local_rank.lteinteger · max: 100Optional

Filters events with a Local Rank less than or equal to the specified value.

Events without a Local Rank will not be returned.

Example: 90

local_rank.ltinteger · max: 100Optional

Filters events with a Local Rank less than the specified value.

Events without a Local Rank will not be returned.

location_confidence_score.gteinteger · min: 1 · max: 5Optional

A unique attribute to Predicted Events that were generated from analyzing sets of recurring events. The score ranges from 1 to 5, representing the event’s propensity to change location with each recurrence. Higher scores indicate a higher consistency in location, while lower scores indicate the event’s location is more likely to shift once additional details become available.

location_confidence_score.gtinteger · min: 1 · max: 5Optional

Filters events with a location confidence score greater than the specified score (exclusive).

location_confidence_score.lteinteger · min: 1 · max: 5Optional

Filters events with a location confidence score less than or equal to the specified score.

location_confidence_score.ltinteger · min: 1 · max: 5Optional

Filters events with a location confidence score less than the specified score (exclusive).

parent.includestring · enumOptional

Whether or not to include parent events / exclude child events.

Note that child events are those events that have a link to a parent event. Parent events are all the other events, whether they have children or not.

See the documentation on umbrella events for more information on parent and child events.

Default: true

Possible values:

phq_attendance.gteintegerOptional

Filters events with a Predicted Attendance greater than or equal to the specified value.

Example: 2000

phq_attendance.gtintegerOptional

Filters events with a Predicted Attendance greater than the specified value.

phq_attendance.lteintegerOptional

Filters events with a Predicted Attendance less than or equal to the specified value.

Example: 10000

phq_attendance.ltintegerOptional

Filters events with a Predicted Attendance less than the specified value.

phq_labelstring[]Optional

A comma-separated list of PHQ labels.

PHQ Labels leverage AI and classifier models for more accurate labelling.

Please note that all event labels are lowercase and that the search is case sensitive.

Take a look at PHQ Label Values to get a list of possible values.

Example: agriculture-forestry-and-fisheries,food-and-beverage

phq_label.opstring · enumOptional

Whether to find events with any or all the specified labels.

Default: any

Possible values:

phq_label.excludestring[]Optional

A comma-separated list of PHQ labels to exclude. This will filter for events that do not have the specified labels.

Please note that all event labels are lowercase and that the search is case sensitive.

Example: lifestyle

phq_label.exclude.opstring · enumOptional

Whether to exclude events with any or all the specified labels.

Default: any

Possible values:

place.scopestring[]Optional

A comma-separated list of Place IDs and/or IATA (3 character), ICAO (4 character), and UN/LOCODE (5 character) airport codes where the events occur.

A CSV file of all supported airport codes and their respective Place IDs is available to download.

Results will contain events that apply to the parent and children places of the specified place. E.g. National, regional and local school holidays that apply to a region.

Example: 5128638,SFO

place.exactstring[]Optional

A comma-separated list of Place IDs and/or IATA (3 character), ICAO (4 character), and UN/LOCODE (5 character) airport codes where the events occur.

Results will contain events that apply to the specified place only. E.g. Regional school holidays only.

placekeystring[]Optional

A comma-separated list of Placekeys (See placekey.io). Returns events that have a Placekey value matching this filter.

There are 2 parts to a Placekey: what@where

• what Contains 2 part in the form {address}-{poi}.
  • The first part represents an address.
  • The second part represents a Point Of Interest (E.g. named venue). This will be missing on locations that only have addresses
• where An H3 hexagon index (resolution 10) of the event.

This filter supports entering a full Placekey to match events having that specific Placekey or a partial Placekey (such as just the @where part) to perform a partial match on Placekey. You can use the following Placekey format in this filter:

• {address}-{poi}@{where} - only returns events with a full matching placekey (an exact match)
• {address}@{where} - matches events where the the address and where part match (even if poi is different)
• @{where} - matches events for which the @where part matches, ignores the {address}-{poi} parts. You can perform a partial match on the @where part to find nearby events. The minimum amount of characters that can be matched on is 5. See using Placekey for more details.

Note that Placekey applies to our attended event categories. Some events do not contain a Placekey.

Example: 225@63j-rqb-j7q,@627-s8j-z2k

postponed.gtestring · date-timeOptional

Filters events that were marked as postponed on or after the specified date.

Note when filtering on postponed, events that are not postponed will not be returned.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

postponed.gtstring · date-timeOptional

Filters events that were marked as postponed after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

postponed.ltestring · date-timeOptional

Filters events that were marked as postponed on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

postponed.ltstring · date-timeOptional

Filters events that were marked as postponed before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

postponed.tzstringOptional

Specifies the timezone for the postponed.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

predicted_end.gtestring · date-timeOptional

Filters events that are predicted to end on or after the specified date.

Note when filtering on postponed, events that are not postponed will not be returned.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

predicted_end.gtstring · date-timeOptional

Filters events that are predicted to end after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

predicted_end.ltestring · date-timeOptional

Filters events that are predicted to end on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

predicted_end.ltstring · date-timeOptional

Filters events that are predicted to end before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

predicted_end.tzstringOptional

Specifies the timezone for the predicted_end.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

predicted_event_spend.gteintegerOptional

Filters events with a Predicted Event Spend (USD) greater or equal to the specified value.

Note: When using this filter events that do not have a predicted_event_spend will not be returned.

Example: 80000

predicted_event_spend.gtintegerOptional

Filters events with a Predicted Event Spend greater than the specified value (exclusive).

predicted_event_spend.lteintegerOptional

Filters events with a Predicted Event Spend less than or equal to the specified value.

Example: 200000

predicted_event_spend.ltintegerOptional

Filters events with a Predicted Event Spend less than the specified value (exclusive).

predicted_event_spend_industry.<industry>.<suffix>integerOptional

The Predicted Event Spend for a given industry in USD.

Supported industries:

• accommodation
• hospitality
• transportation

The format of this parameter name is: predicted_event_spend_industry.<industry>.<suffix>

Supports gt, gte, lt and lte suffixes in the same way other range parameters are supported.

Please note that use of a suffix is required.

Note: When using this filter events that do not have a predicted_event_spend will not be returned.

private.includestring · enumOptional

Whether or not to include private events. Private events are excluded by default.

Private events are those that have the private field set to true. These events are typically not publicly advertised and may have limited information available. They may be included in the API for specific use cases, but are generally not included in search results by default.

Default: false

Possible values:

private.user_idstring[]Optional

A comma-separated list of user identifiers. This filters the events returned to private events that are associated with the specified users.

The private.user_id filter must be used in conjunction with private.include=true or private.include=only.

Example: 12345,67890

qstringOptional

A full-text search query.

Example: katy perry

rank.gteinteger · max: 100Optional

Filters events with a PHQ Rank greater than or equal to the specified value.

Example: 80

rank.gtinteger · max: 100Optional

Filters events with a PHQ Rank greater than the specified value.

rank.lteinteger · max: 100Optional

Filters events with a PHQ Rank less than or equal to the specified value.

Example: 90

rank.ltinteger · max: 100Optional

Filters events with a PHQ Rank less than the specified value.

saved_location.location_idstring[]Optional

A comma-separated list of saved location identifiers. Up to a maximum of 20 identifiers. This filters the events returned to events within the locations specified. Refer to the Saved Locations API for more details on managing locations.

Example: sFlb8HlsLa1j-S4UDEMEkQ

start.gtestring · date-timeOptional

Filters events that start on or after the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

start.gtstring · date-timeOptional

Filters events that start after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

start.ltestring · date-timeOptional

Filters events that start on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

start.ltstring · date-timeOptional

Filters events that start before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

start.tzstringOptional

Specifies the timezone for the start.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

start_date_confidence_score.gteinteger · min: 1 · max: 5Optional

A unique attribute to Predicted Events that were generated from analyzing sets of recurring events. The score ranges from 1 to 5, representing the event’s consistency in being held around the same date with each recurrence. Higher scores indicate the event is held at mostly the same date each year, while lower scores indicate a greater variation in start date, meaning that details are more likely to change as new details become available.

start_date_confidence_score.gtinteger · min: 1 · max: 5Optional

Filters events with a start date confidence score greater than the specified score (exclusive).

start_date_confidence_score.lteinteger · min: 1 · max: 5Optional

Filters events with a start date confidence score less than or equal to the specified score.

start_date_confidence_score.ltinteger · min: 1 · max: 5Optional

Filters events with a start date confidence score less than the specified score (exclusive).

updated.gtestring · date-timeOptional

Filters events that were last modified on or after the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-01-01

updated.gtstring · date-timeOptional

Filters events that were last modified after the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

updated.ltestring · date-timeOptional

Filters events that were last modified on or before the specified date.

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

Example: 2025-02-01

updated.ltstring · date-timeOptional

Filters events that were last modified before the specified date (exclusive).

Expected format: YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.

updated.tzstringOptional

Specifies the timezone for the updated.* date parameters.

Timezone must be in the TZ Database format (e.g. America/Los_Angeles).

Default: UTC

withinstringOptional

A geo center and radius in the form {radius}{unit}@{latitude},{longitude}, where the radius unit can be one of: m, km, ft, mi.

When using the units of km and mi you can enter whole numbers or floats e.g. 5mi, 1.5km or 1.2mi. When using the units ft or m you must enter whole numbers (you cannot enter a fraction of a meter or foot).

Note that results may contain events that apply to a parent scope of the specified area.

Note we always recommend using our Suggested Radius API to determine the relevant impact zone around your location.

Example: [email protected],174.768368

Pattern: ^(?:(?:[1-9]\d*(?:\.\d+)?(km|mi))|(?:[1-9]\d*(m|ft)))@-?\d+(?:\.\d+)?,\-?\d+(?:\.\d+)?$

Responses

200

Successful Response

application/json

The aggregated counts of events matching your filters.

countintegerOptional

The total count of events matching the filters.

top_rankinteger · max: 100Optional

The PHQ Rank of the highest PHQ Ranked event.

top_local_rankinteger · max: 100Optional

The Local Rank of the highest Local Ranked event.

top_aviation_rankinteger · max: 100OptionalDeprecated

The Aviation Rank of the highest Aviation Ranked event.

get

/v1/events/count/

HTTPcURLJavaScriptPython

GET /v1/events/count/ HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "count": 1,
  "top_rank": 1,
  "top_local_rank": 1,
  "rank_levels": {
    "1": 1,
    "2": 1,
    "3": 1,
    "4": 1,
    "5": 1
  },
  "local_rank_levels": {
    "1": 1,
    "2": 1,
    "3": 1,
    "4": 1,
    "5": 1
  },
  "categories": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "phq_labels": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

OpenAPI Spec

The OpenAPI spec for Events API can be found here.

Examples

curl

curl -X GET "https://api.predicthq.com/v1/events/count/?country=NZ" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

python