Get Executions

This endpoint returns the total count of executions for a specified flow, user or connector. It provides a simple way to monitor and retrieve the number of times a particular flow has been executed. Useful for tracking flow usage, analyzing performance metrics, and managing flow lifecycle events.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

start

string

optional

Start of counting time frame (inclusive), schema YYYY-MM-DD, defaults to one month ago

Example:

2024-05-01

end

string

optional

End of counting time frame (inclusive), schema YYYY-MM-DD, defaults to today

Example:

2024-05-31

groupby

string

optional

By which value counts should be grouped by. Supports 'user', 'flow', and ' component', defaults to 'user'

Example:

user

Responses

🟢200Success

application/json

Response when grouping by user

Body

data

array [object {6}]

required

_id

string

required

user

string

required

tenant

string

required

allFlows

array[string]

required

executions

integer

required

username

string

required

metadata

object

required

start

string

required

end

string

required

totalExecutions

integer

required

Example

{
    "data": [
        {
            "_id": "636d0762bd257a7eb2373d6c",
            "user": "636d0762bd257a7eb2373d6c",
            "tenant": "636d0762bd257a7eb2373d6a",
            "allFlows": [
                "6733658b01bea099edcb98c9",
                "673230f301bea099edcb9844",
                "67320a6e01bea099edcb97f2",
                "6733673b01bea099edcb990c",
                "673366e301bea099edcb98ff",
                "6733648601bea099edcb98ba",
                "6732345d01bea099edcb9863"
            ],
            "executions": 49,
            "username": "demo.oih@gmail.com"
        },
        {
            "_id": "664354a82880efa348cf569d",
            "user": "664354a82880efa348cf569d",
            "tenant": "636d0762bd257a7eb2373d6a",
            "allFlows": [
                "666c09ad3f909ad48b0980b8",
                "6671d6d53f909ad48b098374",
                "666c09ae3f909ad48b0980ba",
                "6671d6d43f909ad48b098372"
            ],
            "executions": 1178,
            "username": "f3271fb2051d1a7e828a4ef2695ddae7333f4135b7a935ffe04a5a4c06e85655"
        },
        {
            "_id": "6645bf6fba266a0ca06d9b9d",
            "user": "6645bf6fba266a0ca06d9b9d",
            "tenant": "636d0762bd257a7eb2373d6a",
            "allFlows": [
                "66794760386c949ba07c34ff"
            ],
            "executions": 4,
            "username": "60ac6c68f2c521c7688c65480921d751284628f95221863b0537827deaa2d578"
        },
        {
            "_id": "66f426762533968cb240e787",
            "user": "66f426762533968cb240e787",
            "tenant": "636d0762bd257a7eb2373d6a",
            "allFlows": [
                "672264bda9cde94983185725",
                "67226491a9cde94983185720"
            ],
            "executions": 54,
            "username": "d869d9e7338bbc8d63fa67c1bd31ea5f329ce8d0cd72e1e7a0b910d476241e2c"
        }
    ],
    "metadata": {
        "start": "2024-10-13",
        "end": "2024-11-13",
        "totalExecutions": 1285
    }
}

🟢200Success

Request

Request samples

Responses