Skip to main content
POST
/
events
/
count-by
/
{countable}
Count Account Events
curl --request POST \
  --url https://api.example.com/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": [
        [
          "<string>",
          "<string>"
        ]
      ],
      "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"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.prefect.io/llms.txt

Use this file to discover all available pages before exploring further.

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
​
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