Sign inGet started
Docs
Get started

Get Usage by Workflow

Find out which workflows use the most tasks, highest first, and how embedded usage splits across installations.

GET

Headers

Optional headers
string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

Arguments
string

First day of the window (YYYY-MM-DD). Defaults to 29 days before "to".

string

Last day of the window (YYYY-MM-DD). Defaults to today. Windows are capped at 45 days.

Response fields

workflowIdstring

The workflow.

namestring

Its name.

tasksnumber

Tasks it used in the window.

installationsarray of objects

Embedded usage per installation, highest first: installationId, name (the installation label), integrationId, integrationName, and tasks. Empty for workflows that did not run under an installation. Installation tasks add up to at most the workflow tasks; the remainder ran outside an installation or before meta.installationsFrom, the first day with installation detail.

  • installationIdstring

    The installation.

  • namestring

    The installation label: the integration label template when one is set, otherwise "email - name" of the end user, otherwise the raw id.

  • integrationIdstring

    The embedded integration the installation belongs to.

  • integrationNamestring

    That integration's name.

  • tasksnumber

    Tasks the installation used in the window.