---
title: "Get Event Counts"
method: GET
path: "/v1/events/count/"
tags: ["Events API"]
---

# Get Event Counts

`GET /v1/events/count/`

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

## Query parameters

- `active.gte` string, date-time
- `active.gt` string, date-time
- `active.lte` string, date-time
- `active.lt` string, date-time
- `active.tz` string
- `beam.analysis_id` string
- `beam.group_id` string
- `brand_unsafe.exclude` 'true' | 'false'
- `cancelled.gte` string, date-time
- `cancelled.gt` string, date-time
- `cancelled.lte` string, date-time
- `cancelled.lt` string, date-time
- `cancelled.tz` string
- `category` string[]
- `country` string[]
- `deleted_reason` string[]
- `end.gte` string, date-time
- `end.gt` string, date-time
- `end.lte` string, date-time
- `end.lt` string, date-time
- `end.tz` string
- `entity.id` string[]
- `first_seen.gte` string, date-time
- `first_seen.gt` string, date-time
- `first_seen.lte` string, date-time
- `first_seen.lt` string, date-time
- `first_seen.tz` string
- `id` string[]
- `impact.gte` string, date-time
- `impact.gt` string, date-time
- `impact.lte` string, date-time
- `impact.lt` string, date-time
- `impact.tz` string
- `impact.industry` 'accommodation' | 'cpg' | 'tourism' | 'marketing' | 'parking' | 'restaurants' | 'retail' | 'transportation'
- `label` string[] — Legacy labels to further categorise the event.
- `local_rank.gte` integer
- `local_rank.gt` integer
- `local_rank.lte` integer
- `local_rank.lt` integer
- `local_rank_level` integer[]
- `location_confidence_score.gte` integer
- `location_confidence_score.gt` integer
- `location_confidence_score.lte` integer
- `location_confidence_score.lt` integer
- `parent.include` 'true' | 'false' | 'only'
- `phq_attendance.gte` integer
- `phq_attendance.gt` integer
- `phq_attendance.lte` integer
- `phq_attendance.lt` integer
- `phq_label` string[]
- `phq_label.op` 'all' | 'any'
- `phq_label.exclude` string[]
- `phq_label.exclude.op` 'all' | 'any'
- `place.scope` string[]
- `place.exact` string[]
- `placekey` string[]
- `postponed.gte` string, date-time
- `postponed.gt` string, date-time
- `postponed.lte` string, date-time
- `postponed.lt` string, date-time
- `postponed.tz` string
- `predicted_end.gte` string, date-time
- `predicted_end.gt` string, date-time
- `predicted_end.lte` string, date-time
- `predicted_end.lt` string, date-time
- `predicted_end.tz` string
- `predicted_event_spend.gte` integer
- `predicted_event_spend.gt` integer
- `predicted_event_spend.lte` integer
- `predicted_event_spend.lt` integer
- `predicted_event_spend_industry.<industry>.<suffix>` integer
- `private.include` 'true' | 'false' | 'only'
- `private.user_id` string[]
- `private.org_review` string[]
- `q` string
- `rank.gte` integer
- `rank.gt` integer
- `rank.lte` integer
- `rank.lt` integer
- `rank_level` integer[]
- `saved_location.location_id` string[]
- `sort` string[]
- `start.gte` string, date-time
- `start.gt` string, date-time
- `start.lte` string, date-time
- `start.lt` string, date-time
- `start.tz` string
- `start_date_confidence_score.gte` integer
- `start_date_confidence_score.gt` integer
- `start_date_confidence_score.lte` integer
- `start_date_confidence_score.lt` integer
- `state` string[]
- `updated.gte` string, date-time
- `updated.gt` string, date-time
- `updated.lte` string, date-time
- `updated.lt` string, date-time
- `updated.tz` string
- `within` string

## Response `200`

Successful Response

- EventsCountResponse — The aggregated counts of events matching your filters.
  - `count` integer — The total count of events matching the filters.
  - `top_rank` integer — The PHQ Rank of the highest PHQ Ranked event.
  - `top_local_rank` integer — The Local Rank of the highest Local Ranked event.
  - `top_aviation_rank` integer — The Aviation Rank of the highest Aviation Ranked event.
  - `rank_levels` RankLevelCounts — The count of events broken down by rank level.
    - `1` integer, required — Minor (rank between 0 and 20).
    - `2` integer, required — Moderate (rank between 21 and 40).
    - `3` integer, required — Important (rank between 41 and 60).
    - `4` integer, required — Significant (rank between 61 and 80).
    - `5` integer, required — Major (rank between 81 and 100).
  - `local_rank_levels` RankLevelCounts — The count of events broken down by rank level.
    - `1` integer, required — Minor (rank between 0 and 20).
    - `2` integer, required — Moderate (rank between 21 and 40).
    - `3` integer, required — Important (rank between 41 and 60).
    - `4` integer, required — Significant (rank between 61 and 80).
    - `5` integer, required — Major (rank between 81 and 100).
  - `aviation_rank_levels` RankLevelCounts — The count of events broken down by rank level.
    - `1` integer, required — Minor (rank between 0 and 20).
    - `2` integer, required — Moderate (rank between 21 and 40).
    - `3` integer, required — Important (rank between 41 and 60).
    - `4` integer, required — Significant (rank between 61 and 80).
    - `5` integer, required — Major (rank between 81 and 100).
  - `categories` object — The count of events per category.
  - `labels` object — The count of events broken down by label. As events can have any number of labels these counts are not expected to sum to the total count of events.
  - `phq_labels` object — The count of events broken down by PHQ Label. As events can have any number of PHQ Labels these counts are not expected to sum to the total count of events.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden

---

[API](https://skmtc.net/predicthq/apis/predicthq-events-api.md) · [All operations](https://skmtc.net/predicthq/apis/predicthq-events-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/predicthq/predicthq-events-api/revisions/66cd8ff349dd/schema)