Usage Metrics API

Programmatic access to usage metrics across an organization

The Usage API (released with 5.18.0) provides programmatic access to usage metrics across an organization. It complements existing enterprise reporting options—UI-based usage reports and CSV exports—by enabling integration into internal dashboards and tools via API.

The Usage API is available to all Enterprise customers on both Enterprise SaaS (console.tabnine.com) and Private Installations.

The APIs return JSON with parameter details and example responses.

OpenAPI reference

Organization

Get current organization ID and high-level settings

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response with organization structure.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/organization

GET /api/v1/organization HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "publicKey": "-----BEGIN PUBLIC KEY-----\nMIICIXXXXXXAAQ==\n-----END PUBLIC KEY-----\n",
  "samlEnabled": false,
  "smtpConfigured": true,
  "usernamePasswordEnabled": true,
  "name": "Yagel",
  "domains": [
    "tabnine.com"
  ],
  "planType": "Enterprise",
  "id": "9a3895ca-1c27-4231-8978-85ae00267d02"
}

Get list of teams for the given organization

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

offsetintegerOptional

Skips a number of items before starting to return results.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 0

Responses

200

Successful response with list of teams.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/organization/teams

GET /api/v1/organization/teams HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "usersCount": 1,
      "isDefaultTeam": true
    }
  ],
  "meta": {
    "count": 1,
    "total": 1,
    "next": {
      "limit": 1,
      "offset": 1
    }
  }
}

Get account utilization info (monthly)

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startDatestringOptional

Start date for showing utilization (YYYY-MM). Default: last 12 months.

Example: 2025-01Pattern: ^\d{4}-\d{2}$

Responses

200

Successful response with monthly utilization array.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/organization/account-utilizations

GET /api/v1/organization/account-utilizations HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "year": 1,
    "month": 1,
    "registered": 1,
    "deactivated": 1,
    "active": 1,
    "pending": 1
  }
]

Get organization-level usage

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

organizationIdstringRequired

The unique identifier of the organization

fromstring · date-timeRequired

Filter usage data from this date (ISO 8601).

tostring · date-timeRequired

Filter usage data until this date (ISO 8601).

granularitystring · enumRequired

Time resolution at which usage data is aggregated and returned.

Possible values:

Responses

200

Successful response with organization usage data.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/organization/usage

GET /api/v1/organization/usage?organizationId=text&from=2026-02-23T18%3A46%3A34.728Z&to=2026-02-23T18%3A46%3A34.728Z&granularity=all HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organizationId": "text",
  "from": "2026-02-23T18:46:34.728Z",
  "to": "2026-02-23T18:46:34.728Z",
  "usage": {
    "granularity": "all",
    "data": [
      {
        "from": "2026-02-23T18:46:34.728Z",
        "to": "2026-02-23T18:46:34.728Z",
        "activeUsers": 1,
        "productivityFactor": 1,
        "instruct": {
          "acceptedCount": 1
        },
        "codeCompletions": {
          "activeUsers": 1,
          "completions": 1,
          "charsCompleted": 1,
          "keystrokes": 1,
          "lines": 1,
          "automationFactor": 1
        },
        "chat": {
          "activeUsers": 1,
          "interactions": 1,
          "usefulChatInteractions": 1,
          "lines": 1,
          "charsCompleted": 1,
          "chatConsumptionRate": 1
        },
        "agent": {
          "activeUsers": 1,
          "interactions": 1,
          "linesAdded": 1,
          "linesAddedAccepted": 1,
          "linesRemoved": 1,
          "linesRemovedAccepted": 1
        }
      }
    ]
  }
}

Get users who are not assigned to a team

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

offsetintegerRequired

Skips a number of items before starting to return results.

limitintegerRequired

Maximum number of items to return.

teamMemberbooleanRequired

Use false for users not assigned to a team.

Example: false

activebooleanRequired

Use true for registered users (false for deactivated users).

Example: true

Responses

200

Successful response with users.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/organization/users

GET /api/v1/organization/users?offset=1&limit=1&teamMember=true&active=true HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "username": "text",
      "email": "[email protected]",
      "role": "text",
      "verified": true,
      "deactivatedAt": "2026-02-23T18:46:34.728Z",
      "updatedAt": "2026-02-23T18:46:34.728Z"
    }
  ],
  "meta": {
    "count": 1,
    "total": 1,
    "next": {
      "limit": 1,
      "offset": 1
    }
  }
}

License & permissions

Get license info

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response with license info.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/license

GET /api/v1/license HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "license": {
    "exp": 1,
    "iat": 1,
    "seats": 1,
    "seatsCap": 1,
    "audience": "text",
    "features": [
      "text"
    ],
    "settings": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

Get account permissions info (list of account admins)

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

rolestringRequiredExample: Admin

Responses

200

Successful response with users for the given role.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/instance/permissions

GET /api/v1/instance/permissions?role=text HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "username": "text",
    "organizationId": "text"
  }
]

Team-level

Get users of a given team

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

Query parameters

offsetintegerRequired

Skips a number of items before starting to return results.

limitintegerRequired

Maximum number of items to return.

Responses

200

Successful response with users for the team.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/team/{teamId}/users

GET /api/v1/team/{teamId}/users?offset=1&limit=1 HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "username": "text",
      "email": "[email protected]",
      "role": "text",
      "verified": true,
      "deactivatedAt": "2026-02-23T18:46:34.728Z",
      "updatedAt": "2026-02-23T18:46:34.728Z"
    }
  ],
  "meta": {
    "count": 1,
    "total": 1,
    "next": {
      "limit": 1,
      "offset": 1
    }
  }
}

Get current team utilization info

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

teamIdstringRequired

Responses

200

Successful response with team utilization counts.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/team/account-utilizations

GET /api/v1/team/account-utilizations?teamId=text HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "registered": 1,
  "deactivated": 1,
  "invited": 1
}

Get team name

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

Responses

200

Successful response with team info.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/team/{teamId}

GET /api/v1/team/{teamId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "name": "text"
}

Team-level usage

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

organizationIdstringRequired

teamIdstringRequired

fromstring · date-timeRequired

Filter usage data from this date (ISO 8601).

tostring · date-timeRequired

Filter usage data until this date (ISO 8601).

granularitystring · enumRequired

Time resolution at which usage data is aggregated and returned.

Possible values:

Responses

200

Successful response with team usage data.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

403

Forbidden – User lacks permission.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/team/usage

GET /api/v1/team/usage?organizationId=text&teamId=text&from=2026-02-23T18%3A46%3A34.728Z&to=2026-02-23T18%3A46%3A34.728Z&granularity=all HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organizationId": "text",
  "teamId": "text",
  "from": "2026-02-23T18:46:34.728Z",
  "to": "2026-02-23T18:46:34.728Z",
  "usage": {
    "granularity": "all",
    "data": [
      {
        "from": "2026-02-23T18:46:34.728Z",
        "to": "2026-02-23T18:46:34.728Z",
        "activeUsers": 1,
        "productivityFactor": 1,
        "instruct": {
          "acceptedCount": 1
        },
        "codeCompletions": {
          "activeUsers": 1,
          "completions": 1,
          "charsCompleted": 1,
          "keystrokes": 1,
          "lines": 1,
          "automationFactor": 1
        },
        "chat": {
          "activeUsers": 1,
          "interactions": 1,
          "usefulChatInteractions": 1,
          "lines": 1,
          "charsCompleted": 1,
          "chatConsumptionRate": 1
        },
        "agent": {
          "activeUsers": 1,
          "interactions": 1,
          "linesAdded": 1,
          "linesAddedAccepted": 1,
          "linesRemoved": 1,
          "linesRemovedAccepted": 1
        }
      }
    ]
  }
}

User-level

User-level info

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Responses

200

Successful response with user info.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

403

Forbidden – User lacks permission.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/user/{user_id}

GET /api/v1/user/{user_id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "user": {
    "organization_id": "text",
    "user_id": "text",
    "email": "[email protected]",
    "role": "text",
    "createdAt": "2026-02-23T18:46:34.728Z",
    "updatedAt": "2026-02-23T18:46:34.728Z"
  },
  "teams": {
    "team_id": "text",
    "team_name": "text"
  }
}

User-level usage

GET

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

organizationIdstringRequired

userIdstringRequired

fromstring · date-timeRequired

Filter usage data from this date (ISO 8601).

tostring · date-timeRequired

Filter usage data until this date (ISO 8601).

granularitystring · enumRequired

Time resolution at which usage data is aggregated and returned.

Possible values:

Responses

200

Successful response with user usage data.

application/json

400

Bad Request – Invalid or missing parameters.

401

Unauthorized – Invalid token.

403

Forbidden – User lacks permission.

404

Not Found – Resource not found.

500

Internal Server Error – Unexpected server error.

GET

/api/v1/user/usage

GET /api/v1/user/usage?organizationId=text&userId=text&from=2026-02-23T18%3A46%3A34.728Z&to=2026-02-23T18%3A46%3A34.728Z&granularity=all HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organizationId": "text",
  "userId": "text",
  "from": "2026-02-23T18:46:34.728Z",
  "to": "2026-02-23T18:46:34.728Z",
  "usage": {
    "granularity": "all",
    "data": [
      {
        "from": "2026-02-23T18:46:34.728Z",
        "to": "2026-02-23T18:46:34.728Z",
        "activeUsers": 1,
        "productivityFactor": 1,
        "instruct": {
          "acceptedCount": 1
        },
        "codeCompletions": {
          "activeUsers": 1,
          "completions": 1,
          "charsCompleted": 1,
          "keystrokes": 1,
          "lines": 1,
          "automationFactor": 1
        },
        "chat": {
          "activeUsers": 1,
          "interactions": 1,
          "usefulChatInteractions": 1,
          "lines": 1,
          "charsCompleted": 1,
          "chatConsumptionRate": 1
        },
        "agent": {
          "activeUsers": 1,
          "interactions": 1,
          "linesAdded": 1,
          "linesAddedAccepted": 1,
          "linesRemoved": 1,
          "linesRemovedAccepted": 1
        }
      }
    ]
  }
}

API Categories

The Usage API can retrieve the following information:

Organization & Teams
- Get organization and team IDs
- List organization teams
- List users from each team
Usage Metrics
- Active users
- Account utilization
- Productivity factor
- Automation factor
- Usage volumes for:
  - Code Completions
  - Chat Interactions

List of Implemented APIs

APIs return JSON with parameter details and example responses:

Organization-Level Info APIs and Usage APIs

Get current organization ID and high-level settings
Get list of teams for given organization
Get license info
Get account utilization info
Get account permissions info
Get organization-level usage

Team-Level Info APIs

Get users of a given team
Get users that aren't assigned to a team
Get current utilization info
Get team name
Team Level Usage API

Last updated 12 days ago

Was this helpful?

hashtagOpenAPI reference

hashtagOrganization

hashtagGet current organization ID and high-level settings

hashtagGet list of teams for the given organization

hashtagGet account utilization info (monthly)

hashtagGet organization-level usage

hashtagGet users who are not assigned to a team

hashtagLicense & permissions

hashtagGet license info

hashtagGet account permissions info (list of account admins)

hashtagTeam-level

hashtagGet users of a given team

hashtagGet current team utilization info

hashtagGet team name

hashtagTeam-level usage

hashtagUser-level

hashtagUser-level info

hashtagUser-level usage

hashtagAPI Categories

hashtagList of Implemented APIs

OpenAPI reference

Organization

Get current organization ID and high-level settings

Get list of teams for the given organization

Get account utilization info (monthly)

Get organization-level usage

Get users who are not assigned to a team

License & permissions

Get license info

Get account permissions info (list of account admins)

Team-level

Get users of a given team

Get current team utilization info

Get team name

Team-level usage

User-level

User-level info

User-level usage

API Categories

List of Implemented APIs