Integrations Usage Stats

Before You Begin

• GraphQL Playground:
  🔗 All examples should be run in the GraphQL Playground.
  ➡️ New to GraphQL? Review the Playground Basics Guide.
• Authentication:
  🛠️ Use Service Account tokens (Personal Access Tokens are deprecated).

Prerequisites

• A role with usage stats access (Admin / Super Admin) on the Organization.
• Organization UUID.

Step 1. Find the Organization UUID

Find the organization UUID. You can retrieve it using this query:

{
  organization(id: "<ORGANIZATION_ID>") {
    uuid
  }
}

The organization ID can be found on the home page url: https://app.pipefy.com/organizations/<ORGANIZATION_ID>

Step 2. Execute the query

query integrationsUsageStats($organizationUuid: ID!, $period: PeriodFilter!) {
  integrationsUsageStats(organizationUuid: $organizationUuid, period: $period) {
    tasksConsumed {
      usage
      limit
    }
    activeFlows
    filterDate {
      from
      to
    }
    history {
      nodes {
        date
        usage
        limit
      }
    }
  }
}

Variables:

{
  "organizationUuid": "<ORGANIZATION_UUID>",
  "period": "current_month"
}

Input Explanation:

• organizationUuid: The UUID of the organization you want the usage summary for.
• period: The time window to aggregate. One of current_month, last_month, or last_3_months.

Sample Response:

{
  "data": {
    "integrationsUsageStats": {
      "tasksConsumed": {
        "usage": 42,
        "limit": null
      },
      "activeFlows": 7,
      "filterDate": {
        "from": "2026-06-01T00:00:00Z",
        "to": "2026-06-22T14:23:45Z"
      },
      "history": {
        "nodes": [
          { "date": "2026-06-07", "usage": 2, "limit": null },
          { "date": "2026-06-14", "usage": 29, "limit": null },
          { "date": "2026-06-21", "usage": 11, "limit": null },
          { "date": "2026-06-28", "usage": 0, "limit": null }
        ]
      }
    }
  }
}

The response gives the total tasksConsumed.usage for the period, the number of activeFlows (distinct flows that ran), the resolved filterDate boundaries, and a history time series of tasks consumed per bucket. In the example above (current_month on the 22nd), the history is returned as four weekly buckets — one per anchored week elapsed so far — each usage being the tasks consumed within that week.

Key Notes

• History granularity follows the period:
  • current_month and last_month return weekly buckets. The week of a day is ceil(day_of_month / 7) (W1 = days 1–7, W2 = 8–14, W3 = 15–21, W4 = 22–28, W5 = 29–end). Each bucket's date (yyyy-MM-dd) is the last day of its week (min(week * 7, days_in_month)), and its usage is the incremental tasks consumed within that week. Weeks with no consumption are returned with usage: 0. current_month returns the weeks elapsed so far; last_month returns every week of the month.
  • last_3_months returns monthly buckets (date as yyyy-MM), each usage being the incremental monthly total.
• limit (on both tasksConsumed and each history node) is the tasks allowance for the organization. It returns null while no allowance is mapped for the organization.
• For the per-flow breakdown of this usage, see Integrations usage details query.