Count Account Events

Returns distinct objects and the count of events associated with them. Objects that can be counted include the day the event occurred, the type of event, or the IDs of the resources associated with the event.

Headers

x-prefect-api-version

string

Path Parameters

countable

enum<string>

required

Available options:

day,

time,

event,

resource

Body

application/json

filter

object

required

Show child attributes

filter.any_resource

object | null

Filter criteria for any resource involved in the event

Show child attributes

filter.any_resource.id

string[] | null

Only include events for resources with these IDs

filter.any_resource.id_prefix

string[] | null

Only include events for resources with IDs starting with these prefixes

filter.any_resource.labels

object | null

Only include events for related resources with these labels

Show child attributes

filter.any_resource.labels.{key}

filter.event

object | null

Filter criteria for the event name

Show child attributes

filter.event.exclude_name

string[] | null

Exclude events matching one of these names exactly

filter.event.exclude_prefix

string[] | null

Exclude events matching one of these prefixes

filter.event.name

string[] | null

Only include events matching one of these names exactly

filter.event.prefix

string[] | null

Only include events matching one of these prefixes

filter.id

object

Filter criteria for the events' ID

Show child attributes

filter.id.id

string[] | null

Only include events with one of these IDs

filter.occurred

object

Filter criteria for when the events occurred

Show child attributes

filter.occurred.since

string

Only include events after this time (inclusive)

filter.occurred.until

string

Only include events prior to this time (inclusive)

filter.order

enum<string>

The order to return filtered events

Available options:

ASC,

DESC

filter.related

object | null

Filter criteria for the related resources of the event

Show child attributes

filter.related.id

string[] | null

Only include events for related resources with these IDs

filter.related.labels

object | null

Only include events for related resources with these labels

Show child attributes

filter.related.labels.{key}

filter.related.resources_in_roles

array | null

Only include events with specific related resources in specific roles

filter.related.role

string[] | null

Only include events for related resources in these roles

filter.resource

object | null

Filter criteria for the resource of the event

Show child attributes

filter.resource.distinct

boolean

default:

false

Only include events for distinct resources

filter.resource.id

string[] | null

Only include events for resources with these IDs

filter.resource.id_prefix

string[] | null

Only include events for resources with IDs starting with these prefixes.

filter.resource.labels

object | null

Only include events for resources with these labels

Show child attributes

filter.resource.labels.{key}

time_interval

number

default:

1

Required range: x > 0.01

time_unit

enum<string>

Available options:

week,

day,

hour,

minute,

second

Response

200 - application/json

count

integer

required

The count of matching events

end_time

string

required

The end time of this group of events

label

string

required

The value to display for this count

start_time

string

required

The start time of this group of events

value

string

required

The value to use for filtering