Usage

GET /v1/usage

Request

  • Base URL
    https://api.virtuall.pro
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Query parameters

userIdstring[]

User UUID. Repeat the parameter to include usage from multiple users.

engineIdstring[]

Engine ID. Repeat the parameter to include multiple engines.

formatstring[]

Generated output format. Repeat the parameter to include multiple formats.

userGroupIdstring[]

Current user-group UUID. Repeat the parameter to include members of multiple groups.

regularCreditCostEurnumber nullable

EUR cost assigned to each regular credit when calculating spend.

Example:0.06
overdraftCreditCostEurnumber nullable

EUR cost assigned to each overdraft credit when calculating spend.

Example:0.06
startDatestring date-time required

Inclusive ISO 8601 timestamp with a timezone offset.

Example:2026-09-01T00:00:00Z
endDatestring date-time required

Inclusive ISO 8601 timestamp with a timezone offset.

Example:2026-09-01T00:00:00Z

Response

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

regularCreditCostEurnumber required
overdraftCreditCostEurnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.