Default module

Get Executions

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startstringOptional

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

Example: 2024-05-01

endstringOptional

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

Example: 2024-05-31

groupbystringOptional

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

Example: user

Responses

200

Response when grouping by user

application/json

x-200:Success

Response when grouping by flow

application/json

get/icenter/executions

GET /icenter/executions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "_id": "636d0762bd257a7eb2373d6c",
      "user": "636d0762bd257a7eb2373d6c",
      "tenant": "636d0762bd257a7eb2373d6a",
      "allFlows": [
        "6733658b01bea099edcb98c9",
        "673230f301bea099edcb9844",
        "67320a6e01bea099edcb97f2",
        "6733673b01bea099edcb990c",
        "673366e301bea099edcb98ff",
        "6733648601bea099edcb98ba",
        "6732345d01bea099edcb9863"
      ],
      "executions": 49,
      "username": "[e-mail]"
    },
    {
      "_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
  }
}

Get Logs

get

The Get Logs endpoint allows you to retrieve all available logs from the system. You can filter the results by flow, by step, or choose to only display error logs. This makes it possible to set up monitoring scenarios, for example by creating a flow that automatically notifies you whenever new errors occur.

Query parameters

filter[flowId]stringOptionalExample: {flowId}

filter[stepId]stringOptionalExample: {stepId}

filter[tenant]stringRequiredExample: {tenantId)

showErrorsstringOptionalExample: true

Responses

200Success

application/json

objectOptional

get/logs

GET /logs?filter[tenant]=text HTTP/1.1
Accept: */*

200Success

{}

Incoming Webhook

post

Within your system’s webhook functionality, create and configure a webhook to send relevant data as a POST request to the webhook url using the user’s flow ID. You can send payload data via POST request using JSON in the request body, which will then be processed in the flow.

Path parameters

flowIdstringRequired

Responses

200Success

application/json

objectOptional

post/webhooks/{flowId}

POST /webhooks/{flowId} HTTP/1.1
Accept: */*

200Success

{}