Usage Metrics API - Licenses

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:

Licenses & Permissions

1. GET license info

2. GET instance permissions

Get License Information

Returns license metadata for the current Tabnine instance. Use it to validate entitlements before pulling usage metrics.

Get license info

GET

Authorizations

bearerAuth

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

HTTPcURLJavaScriptPython

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

Returns the permissions enabled on this Tabnine instance. Use it to gate tooling features and API calls by permission.

Get account permissions info (list of account admins)

GET

Authorizations

bearerAuth

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

HTTPcURLJavaScriptPython

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

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