---
title: "Get user billable compute metrics"
method: GET
path: "/api/user/subscription/metrics"
tags: ["User"]
---

# Get user billable compute metrics

`GET /api/user/subscription/metrics`

## Request

- Base URL: `https://studio.edgeimpulse.com/v1`
- URL: `https://studio.edgeimpulse.com/v1/api/user/subscription/metrics`
- Auth: one of:
  - API key in header `x-api-key`
  - API key in cookie `jwt`
  - API key in header `x-jwt-token`
  - OAuth 2
    - Authorization code: `/v1/oauth/authorize`
    - Client credentials
    - Implicit: `/v1/oauth/authorize`
    - Password
    - Token URL: `/v1/oauth/token`
- TypeScript: <https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/user/subscription/metrics/get.ts> (a function with typed inputs; its response is checked against the schema)

Get billable compute metrics for a user. This function is only available to users with an active subscription.

## Response `200`

OK

- UserSubscriptionMetricsResponse
  - `success` boolean, required: Whether the operation succeeded
  - `error` string: Optional error description (set if 'success' was false)
  - `metrics` object
    - `computeMinutesCpu` number, required: Total compute of all user jobs, running on CPU, in the current billing period.
    - `computeMinutesGpu` number, required: Total compute of all user jobs, running on GPU, in the current billing period.
    - `computeMinutesTotal` number, required: Total compute of all user jobs in the current billing period, calculated as CPU + 3*GPU compute.
    - `computeMinutesLimit` number, required: Overall compute limit for the current billing period.
    - `computeResetDate` string, date-time: The date at which the current compute billing period will reset.
  - `approachingComputeLimitMinutesLeft` number: Number of compute minutes remaining before reaching the monthly compute limit. This field is only present when the user has fewer than 60 minutes left. Once the limit is reached, users can continue using compute resources by subscribing to the pay-as-you-go plan.

---

[API](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api.md) - [All operations](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/llms.txt) - [OpenAPI document](https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/revisions/e2a976d38427?raw)
