---
title: "GET /v1/usage"
method: GET
path: "/v1/usage"
tags: ["Usage"]
---

# GET /v1/usage

`GET /v1/usage`

## Request

- Base URL: `https://api.virtuall.pro`
- URL: `https://api.virtuall.pro/v1/usage`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

## Query parameters

- `userId` string[]: User UUID. Repeat the parameter to include usage from multiple users.
- `engineId` string[]: Engine ID. Repeat the parameter to include multiple engines.
- `format` string[]: Generated output format. Repeat the parameter to include multiple formats.
- `userGroupId` string[]: Current user-group UUID. Repeat the parameter to include members of multiple groups.
- `regularCreditCostEur` number, nullable: EUR cost assigned to each regular credit when calculating spend.
- `overdraftCreditCostEur` number, nullable: EUR cost assigned to each overdraft credit when calculating spend.
- `startDate` string, date-time, required: Inclusive ISO 8601 timestamp with a timezone offset.
- `endDate` string, date-time, required: Inclusive ISO 8601 timestamp with a timezone offset.

## Response `200`

Filtered studio credit spend, as a grand total and totals per user

- UsageReport
  - `regularCreditCostEur` number, required
  - `overdraftCreditCostEur` number, required
  - `totalSpend` object, required
    - `credits` integer, required
    - `regularCredits` integer, required
    - `overdraftCredits` integer, required
    - `eur` number, required
  - `perUserTotals` object[], required
    - `userId` string, uuid, nullable, required
    - `userName` string, required
    - `userEmail` string, nullable, required
    - `credits` integer, required
    - `regularCredits` integer, required
    - `overdraftCredits` integer, required
    - `eur` number, required

## Other responses

- `400`: Invalid request
- `401`: Authentication required or invalid
- `403`: Permission denied
- `404`: Resource unavailable or API feature disabled
- `429`: Rate limit exceeded
- `500`: Unexpected server error
- `503`: Service temporarily unavailable

---

[API](https://skmtc.dev/virtuall/apis/virtuall-external-api.md) - [All operations](https://skmtc.dev/virtuall/apis/virtuall-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/virtuall/apis/virtuall-external-api/revisions/2b3a30238ce0?raw)