Zum Hauptinhalt springen
GET
/
billing
/
usage-analytics
/api/v1/billing/usage-analytics
curl --request GET \
  --url https://api.venice.ai/api/v1/billing/usage-analytics \
  --header 'Authorization: Bearer <token>'
{
  "lookback": "7d",
  "byDate": [
    {
      "date": "2024-01-15T00:00:00.000Z",
      "USD": 0.5,
      "DIEM": 10.25
    },
    {
      "date": "2024-01-14T00:00:00.000Z",
      "USD": 0.3,
      "DIEM": 8.75
    }
  ],
  "byModel": [
    {
      "modelName": "GLM 5.1",
      "unitType": "tokens",
      "modelType": "LLM",
      "totalUsd": 0.4,
      "totalDiem": 12.5,
      "totalUnits": 50000,
      "breakdown": [
        {
          "type": "Output",
          "usd": 0.3,
          "diem": 10,
          "units": 35000
        },
        {
          "type": "Input",
          "usd": 0.1,
          "diem": 2.5,
          "units": 15000
        }
      ]
    }
  ],
  "byModelDaily": [
    {
      "date": 1705276800000,
      "GLM 5.1": 5.5,
      "Kimi K2.6": 3.2
    }
  ],
  "topModels": [
    "GLM 5.1",
    "Kimi K2.6"
  ],
  "byKey": [
    {
      "apiKeyId": "key_abc123",
      "description": "Production Key",
      "totalUsd": 0.8,
      "totalDiem": 15,
      "totalUnits": 75000
    },
    {
      "apiKeyId": null,
      "description": "Web App",
      "totalUsd": 0,
      "totalDiem": 4,
      "totalUnits": 25000
    }
  ],
  "byKeyDaily": [
    {
      "date": 1705276800000,
      "Production Key": 8.5,
      "Web App": 2
    }
  ],
  "topKeyNames": [
    "Production Key",
    "Web App"
  ]
}
Dies ist ein Beta-Endpoint und kann instabil sein oder sich ohne Vorankündigung ändern.
Rufen Sie aggregierte Nutzungsanalysen für den authentifizierten Benutzer ab, mit Aufschlüsselungen nach Datum, Modell und API-Schlüssel. Dieser Endpoint liefert zusammenfassende Ansichten Ihrer API-Nutzungsdaten zur Erstellung von Dashboards und zur Verbrauchsüberwachung. Die Daten werden 10 Minuten lang zwischengespeichert.

​
Query-Parameter

Sie können den Zeitraum für die Analyse auf eine der folgenden Arten angeben:
  • lookback: Ein relativer Zeitraum wie “7d” (7 Tage), “30d” (30 Tage), bis zu “90d” (90 Tage)
  • startDate und endDate: Ein benutzerdefinierter Datumsbereich im Format YYYY-MM-DD. Beide sind erforderlich, wenn eines angegeben wird.
Wenn keine Parameter angegeben werden, beträgt der Standard-Lookback-Zeitraum 7 Tage.

​
Antwortfelder

​
lookback

Der für die Abfrage verwendete Lookback-Zeitraum. Entweder im Format “Nd” (z. B. “7d”) oder im Format “startDate:endDate”.

​
byDate

Tägliche Nutzungssummen für den angeforderten Zeitraum.
  • date: Das Datum im Format YYYY-MM-DD
  • USD: Gesamtnutzung in USD an diesem Tag
  • DIEM: Gesamtnutzung in DIEM an diesem Tag

​
byModel

Nutzungsaufschlüsselung nach Modell, sortiert nach Gesamtausgaben (höchste zuerst).
  • modelName: Anzeigename des Modells (z. B. “GLM 5”)
  • unitType: Art der verbrauchten Einheiten (tokens, images, chars, minutes, seconds)
  • modelType: Modelltyp (LLM, IMAGE, TTS, ASR, VIDEO) oder null
  • totalUsd: Gesamtausgaben in USD für dieses Modell
  • totalDiem: Gesamtausgaben in DIEM für dieses Modell
  • totalUnits: Gesamteinheiten, die für dieses Modell verbraucht wurden
  • breakdown: Array mit Nutzungsaufschlüsselungen nach Typ (nur vorhanden, wenn mehrere Typen vorliegen). Jeder Eintrag enthält:
    • type: Token-Typ (z. B. “Input”, “Output”, “Cache Read”, “Cache Write”)
    • usd: USD-Betrag für diese Aufschlüsselung
    • diem: DIEM-Betrag für diese Aufschlüsselung
    • units: Anzahl der Einheiten für diese Aufschlüsselung

​
byModelDaily

Tägliche Chart-Daten für die Top-8-Modelle. Jeder Eintrag enthält ein “date” (Zeitstempel) sowie Modellnamen als Schlüssel mit DIEM-Nutzungswerten.

​
topModels

Array der Top-8-Modellnamen nach Nutzung, für Chart-Legenden.

​
byKey

Nutzungsaufschlüsselung nach API-Schlüssel, sortiert nach Gesamtausgaben (höchste zuerst).
  • apiKeyId: Die API-Schlüssel-ID oder null, wenn die Nutzung über die Web-App erfolgte
  • description: API-Schlüssel-Beschreibung oder “Web App”
  • totalUsd: Gesamtausgaben in USD über diesen Schlüssel
  • totalDiem: Gesamtausgaben in DIEM über diesen Schlüssel
  • totalUnits: Gesamteinheiten, die über diesen Schlüssel verbraucht wurden

​
byKeyDaily

Tägliche Chart-Daten für die Top-8-API-Schlüssel. Jeder Eintrag enthält ein “date” (Zeitstempel) sowie Schlüsselbeschreibungen als Schlüssel mit DIEM-Nutzungswerten.

​
topKeyNames

Array der Top-8-API-Schlüssel-Beschreibungen nach Nutzung, für Chart-Legenden.

​
Beispielnutzung

# Nutzungsanalysen für die letzten 7 Tage abrufen (Standard)
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Nutzungsanalysen für die letzten 30 Tage abrufen
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?lookback=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Nutzungsanalysen für einen bestimmten Datumsbereich abrufen
curl -X GET "https://api.venice.ai/api/v1/billing/usage-analytics?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_KEY"

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Abfrageparameter

​
lookback
string
Standard:7d

Lookback period for usage data. Format: number followed by "d" (e.g., "7d", "30d"). Maximum: 90d

Pattern: ^[1-9]\d*d$
Beispiel:

"7d"

​
startDate
string

Start date for filtering records (YYYY-MM-DD). If provided, endDate is also required.

Pattern: ^\d{4}-\d{2}-\d{2}$
Beispiel:

"2024-01-01T00:00:00.000Z"

​
endDate
string

End date for filtering records (YYYY-MM-DD). If provided, startDate is also required.

Pattern: ^\d{4}-\d{2}-\d{2}$
Beispiel:

"2024-01-31T00:00:00.000Z"

Antwort

Successful response with aggregated usage analytics

Aggregated usage analytics response with breakdowns by date, model, and API key

​
lookback
string
erforderlich

The lookback period used for the query. Either "Nd" format or "startDate:endDate" format.

Beispiel:

"7d"

​
byDate
object[]
erforderlich

Daily usage totals for the requested period

​
byModel
object[]
erforderlich

Usage breakdown by model, sorted by total spend (highest first)

​
byModelDaily
object[]
erforderlich

Daily chart data for top 8 models. Each entry has "date" (timestamp) plus model names as keys.

​
topModels
string[]
erforderlich

Names of the top 8 models by usage (for chart legends)

​
byKey
object[]
erforderlich

Usage breakdown by API key, sorted by total spend (highest first)

​
byKeyDaily
object[]
erforderlich

Daily chart data for top 8 API keys. Each entry has "date" (timestamp) plus key descriptions as keys.

​
topKeyNames
string[]
erforderlich

Descriptions of the top 8 API keys by usage (for chart legends)