Usage Metrics API - Teams & Users

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.

List of Implemented APIs

APIs return JSON with parameter details and example responses:

Team-Level Info APIs

1. GET users of a given team

2. GET current utilization info

3. GET teamId

4. GET team-wide usage

User-Level Info APIs

1. GET userId

2. GET usage

Team-Level

Get users of a given team

GET

Authorizations

bearerAuth

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

HTTPcURLJavaScriptPython

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-03-03T17:42:52.146Z",
      "updatedAt": "2026-03-03T17:42:52.146Z"
    }
  ],
  "meta": {
    "count": 1,
    "total": 1,
    "next": {
      "limit": 1,
      "offset": 1
    }
  }
}

Get current team utilization info

GET

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

teamIdstringRequired

Responses

200

Successful response with team utilization counts.

application/json

registeredintegerRequired

deactivatedintegerRequired

invitedintegerRequired

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

HTTPcURLJavaScriptPython

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

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

teamIdstringRequired

Responses

200

Successful response with team info.

application/json

idstringRequired

namestringRequired

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}

HTTPcURLJavaScriptPython

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

bearerAuth

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

organizationIdstringRequired

teamIdstringRequired

fromstring · date-timeRequired

tostring · date-timeRequired

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

HTTPcURLJavaScriptPython

GET /api/v1/team/usage?organizationId=text&teamId=text&from=2026-03-03T17%3A42%3A52.146Z&to=2026-03-03T17%3A42%3A52.146Z&granularity=all HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organizationId": "text",
  "teamId": "text",
  "from": "2026-03-03T17:42:52.146Z",
  "to": "2026-03-03T17:42:52.146Z",
  "usage": {
    "granularity": "all",
    "data": [
      {
        "from": "2026-03-03T17:42:52.146Z",
        "to": "2026-03-03T17:42:52.146Z",
        "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

bearerAuth

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}

HTTPcURLJavaScriptPython

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-03-03T17:42:52.146Z",
    "updatedAt": "2026-03-03T17:42:52.146Z"
  },
  "teams": {
    "team_id": "text",
    "team_name": "text"
  }
}

User-level usage

GET

Authorizations

bearerAuth

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

organizationIdstringRequired

userIdstringRequired

fromstring · date-timeRequired

tostring · date-timeRequired

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

HTTPcURLJavaScriptPython

GET /api/v1/user/usage?organizationId=text&userId=text&from=2026-03-03T17%3A42%3A52.146Z&to=2026-03-03T17%3A42%3A52.146Z&granularity=all HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "organizationId": "text",
  "userId": "text",
  "from": "2026-03-03T17:42:52.146Z",
  "to": "2026-03-03T17:42:52.146Z",
  "usage": {
    "granularity": "all",
    "data": [
      {
        "from": "2026-03-03T17:42:52.146Z",
        "to": "2026-03-03T17:42:52.146Z",
        "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
        }
      }
    ]
  }
}