Count Account Events

curl --request POST \
  --url https://api.example.com/api/events/count-by/{countable} \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "occurred": {
      "since": "2023-11-07T05:31:56Z",
      "until": "2023-11-07T05:31:56Z"
    },
    "event": {
      "prefix": [
        "<string>"
      ],
      "exclude_prefix": [
        "<string>"
      ],
      "name": [
        "<string>"
      ],
      "exclude_name": [
        "<string>"
      ]
    },
    "resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {},
      "distinct": false
    },
    "related": {
      "id": [
        "<string>"
      ],
      "role": [
        "<string>"
      ],
      "resources_in_roles": [
        "<array>"
      ],
      "labels": {}
    },
    "any_resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {}
    },
    "id": {
      "id": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "text": {
      "query": "<string>"
    },
    "order": "DESC"
  },
  "time_unit": "day",
  "time_interval": 1
}
'

[
  {
    "value": "<string>",
    "label": "<string>",
    "count": 123,
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  }
]

POST

api

events

count-by

{countable}

Count Account Events

curl --request POST \
  --url https://api.example.com/api/events/count-by/{countable} \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "occurred": {
      "since": "2023-11-07T05:31:56Z",
      "until": "2023-11-07T05:31:56Z"
    },
    "event": {
      "prefix": [
        "<string>"
      ],
      "exclude_prefix": [
        "<string>"
      ],
      "name": [
        "<string>"
      ],
      "exclude_name": [
        "<string>"
      ]
    },
    "resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {},
      "distinct": false
    },
    "related": {
      "id": [
        "<string>"
      ],
      "role": [
        "<string>"
      ],
      "resources_in_roles": [
        "<array>"
      ],
      "labels": {}
    },
    "any_resource": {
      "id": [
        "<string>"
      ],
      "id_prefix": [
        "<string>"
      ],
      "labels": {}
    },
    "id": {
      "id": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    },
    "text": {
      "query": "<string>"
    },
    "order": "DESC"
  },
  "time_unit": "day",
  "time_interval": 1
}
'

[
  {
    "value": "<string>",
    "label": "<string>",
    "count": 123,
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  }
]

Headers

x-prefect-api-version

string

Path Parameters

countable

enum<string>

required

Available options:

day,

time,

event,

resource

Body

application/json

filter

EventFilter · object

required

Show child attributes

filter.occurred

EventOccurredFilter · object

Filter criteria for when the events occurred

Show child attributes

filter.occurred.since

string<date-time>

Only include events after this time (inclusive)

filter.occurred.until

string<date-time>

Only include events prior to this time (inclusive)

filter.event

EventNameFilter · object

Filter criteria for the event name

Show child attributes

filter.event.prefix

string[] | null

Only include events matching one of these prefixes

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.exclude_name

string[] | null

Exclude events matching one of these names exactly

filter.resource

EventResourceFilter · object

Filter criteria for the resource of the event

Show child attributes

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

ResourceSpecification · object

Only include events for resources with these labels

Show child attributes

filter.resource.labels.{key}

filter.resource.distinct

boolean

default:false

Only include events for distinct resources

Filter criteria for the related resources of the event

EventRelatedFilter · object
EventRelatedFilter · object[]

Show child attributes

Only include events for related resources with these IDs

Only include events for related resources in these roles

Only include events with specific related resources in specific roles

Required array length: 2 elements

Only include events for related resources with these labels

Show child attributes

filter.any_resource

EventAnyResourceFilter · object

Filter criteria for any resource involved in the event

EventAnyResourceFilter · object
EventAnyResourceFilter · object[]

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

ResourceSpecification · object

Only include events for related resources with these labels

Show child attributes

filter.any_resource.labels.{key}

filter.id

EventIDFilter · object

Filter criteria for the events' ID

Show child attributes

filter.id.id

string<uuid>[] | null

Only include events with one of these IDs

filter.text

EventTextFilter · object

Filter criteria for text search across event content

Show child attributes

filter.text.query

string

required

Text search query string

Maximum string length: 200

filter.order

enum<string>

default:DESC

The order to return filtered events

Available options:

ASC,

DESC

time_unit

enum<string>

default:day

Available options:

week,

day,

hour,

minute,

second

time_interval

number

default:1

Required range: x >= 0.01

Response

Successful Response

value

string

required

The value to use for filtering

label

string

required

The value to display for this count

count

integer

required

The count of matching events

start_time

string<date-time>

required

The start time of this group of events

end_time

string<date-time>

required

The end time of this group of events

Read Account Events Page Create Automation

⌘I

API Reference

Headers

Path Parameters

Body

Response