Built In reports

Pre-built reports that surface metrics from Swarmia. Each report endpoint returns rows with a fixed set of metrics, a schema describing its properties, and an optional summary row that aggregates across all rows.

Organization AI assistant overview

get

Overview of AI assistant usage in the organization.

Supported revisions: 1 (latest is equivalent).

Authorizations

bearerToken

AuthorizationstringRequired

API token passed as Authorization: Bearer <token>. The token must have the entityQuery scope enabled. Tokens can be provisioned at https://app.swarmia.com/settings/api-tokens.

Query parameters

outputstring · enumOptional

Response format.

Default: jsonPossible values:

revisionstringRequired

Report revision to serve. Use latest to request the highest supported revision for this report. The served revision is echoed in the X-Swarmia-Report-Revision response header.

The deprecated version query parameter is accepted as an alias.

Example: 1

timeframe.startstring · dateRequired

Start of the reporting period (inclusive).

Example: 2026-01-01

timeframe.endstring · dateRequired

End of the reporting period (inclusive).

Example: 2026-02-01

timezonestringOptional

IANA timezone used to interpret the date-only timeframe.start and timeframe.end values and for time bucketing. Defaults to UTC.

Default: UTCExample: America/New_York

teamIdstringOptional

Comma-separated team UUIDs. Only these teams are included. Use either this or parentTeamId, not both. Omit both to return all teams.

Example: 4d9361ab-3217-4690-957e-ca69abe9ca07,972cedde-3104-454a-a048-f27f43539442

parentTeamIdstringOptional

Comma-separated parent-team UUIDs. Returns children of these teams. Use the literal value null (or an empty value) to select only top-level teams (teams with no parent). Use either this or teamId, not both. Omit both to return all teams.

Example: null

activeContributorsOnlybooleanOptional

When true (default), only count team members who opened at least one PR during the time period. When false, count all team members.

Default: true

aiAssistantsstringOptional

Comma-separated list of AI assistants to include. Omit to include all.

Example: GithubCopilot,Cursor,ClaudeCode

Responses

200

Successful response.

application/jsontext/csv

400

Invalid or unknown parameters.

application/json

401

Missing or invalid API token.

get

/reports/ai/adoption/users-and-licenses

HTTPcURLJavaScriptPython

GET /api/v1/reports/ai/adoption/users-and-licenses?revision=1&timeframe.start=2026-01-01&timeframe.end=2026-02-01 HTTP/1.1
Host: app.swarmia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schema": {
    "_key": {
      "title": "Team",
      "description": "Teams represent your organization structure and are the owners of other entities like Issues and Pull requests."
    },
    "enabledAiUsers": {
      "title": "Ai tool enabled users",
      "description": "The ID of the author of the activity",
      "aggregate": "ArrayAggDistinct"
    },
    "activeAiUsers": {
      "title": "Active users",
      "description": "The ID of the author of the activity",
      "aggregate": "ArrayAggDistinct"
    },
    "enabledAiUserCount": {
      "title": "AI assistant enabled",
      "description": "Contributors with an AI assistant license at some point during the time period",
      "aggregate": "CountDistinct"
    },
    "activeAiUserCount": {
      "title": "Active user count",
      "description": "Contributors who used an AI assistant at some point during the time period",
      "aggregate": "CountDistinct"
    },
    "contributorCount": {
      "title": "Contributors",
      "description": "Number of team members who created at least one PR during the time period.",
      "aggregate": "CountDistinct"
    },
    "weeklyActiveAvg": {
      "title": "Weekly active, avg.",
      "description": "Average number of active users per week. Calculated as total active users divided by number of weeks in the time period."
    },
    "enabledRate": {
      "title": "Enabled rate",
      "description": "AI assistant enabled / contributors"
    }
  },
  "rows": [
    {
      "_key": {
        "type": "Team",
        "id": "d8345f20-7c0f-4709-b1c7-cd7e0444da46",
        "name": "Frontend"
      },
      "enabledAiUsers": [
        {
          "type": "Author",
          "id": "670f1dcf-e026-4551-af08-d27c39865995",
          "name": "Alice",
          "email": "[email protected]"
        }
      ],
      "activeAiUsers": [
        {
          "type": "Author",
          "id": "670f1dcf-e026-4551-af08-d27c39865995",
          "name": "Alice",
          "email": "[email protected]"
        }
      ],
      "enabledAiUserCount": 1,
      "activeAiUserCount": 1,
      "contributorCount": 1,
      "weeklyActiveAvg": 1,
      "enabledRate": 100
    },
    {
      "_key": {
        "type": "Team",
        "id": "6d7db279-6112-4271-b197-84066b631db2",
        "name": "Backend"
      },
      "enabledAiUsers": [
        {
          "type": "Author",
          "id": "98078272-8f5c-450e-bea7-6424a70f1d49",
          "name": "Bob",
          "email": "[email protected]"
        }
      ],
      "activeAiUsers": [],
      "enabledAiUserCount": 1,
      "activeAiUserCount": 0,
      "contributorCount": 1,
      "weeklyActiveAvg": 0,
      "enabledRate": 100
    }
  ],
  "summaryRow": {
    "enabledAiUsers": [
      {
        "id": "670f1dcf-e026-4551-af08-d27c39865995",
        "type": "Author",
        "name": "Alice",
        "email": "[email protected]"
      },
      {
        "id": "98078272-8f5c-450e-bea7-6424a70f1d49",
        "type": "Author",
        "name": "Bob",
        "email": "[email protected]"
      }
    ],
    "activeAiUsers": [
      {
        "id": "670f1dcf-e026-4551-af08-d27c39865995",
        "type": "Author",
        "name": "Alice",
        "email": "[email protected]"
      }
    ],
    "enabledAiUserCount": 2,
    "activeAiUserCount": 1,
    "contributorCount": 2,
    "weeklyActiveAvg": 1,
    "enabledRate": 100
  }
}