Obtenir votre quota restant

Paramètres

Lingara-Versionheaderstringfacultatif

La version de l'API sous laquelle traiter cette requête. Sans elle, un jeton d'accès obtient la version à laquelle son client est rattaché, et une requête sans jeton obtient la version actuelle. La version encore en développement ne s'atteint qu'en la nommant ici. Une version inconnue répond 400 avec le code api_version_unknown. GET /v1/versions liste les versions.

Réponses

200 Votre quota

allowancearray of AllowanceRowobligatoire

featurestringobligatoire

windowstringobligatoire

limitintegerobligatoire

usedintegerobligatoire

remainingintegerobligatoire

reset_atinteger | nullfacultatif

ledgerUsageLedger | nullfacultatif

Les appels et unités de ce client depuis minuit UTC le premier du mois. Présent uniquement pour un client facturé à l'usage, dont les appels ne consomment aucun quota. Peut avoir jusqu'à cinq secondes de retard sur votre dernier appel.

sincestringobligatoire

callsintegerobligatoire

unitsintegerobligatoire

Erreurs

410application/json

La version de l'API sous laquelle cette requête est traitée a été retirée. Envoyez une version prise en charge dans Lingara-Version, ou rattachez le client à une autre version.

4XXapplication/json

La requête a été refusée. code indique pourquoi, et error l'explique en toutes lettres.

503application/json · text/plain

Le service est temporairement indisponible ; réessayez après le nombre de secondes indiqué dans Retry-After. Pendant la maintenance, le corps est du texte brut plutôt que l'enveloppe d'erreur.

5XXapplication/json

La requête a été refusée. code indique pourquoi, et error l'explique en toutes lettres.

codestringobligatoire

Pourquoi la requête a été refusée, sous forme de code stable sur lequel brancher votre logique : par exemple insufficient_scope (403), rate_limited (429) et, pour un client facturé à l'usage, spend_cap_reached (402) et metered_billing_inactive (402).

errorstringobligatoire

Exemple

curl "https://api.getlingara.com/v1/usage" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

const usage = await client.getUsage();
for (const row of usage.allowance) {
  console.log(row.feature, row.window, `${row.remaining} of ${row.limit} left`);
}

let usage = client.get_usage().await?;
for row in &usage.allowance {
    println!("{} {}: {} of {} left", row.feature, row.window, row.remaining, row.limit);
}

usage, err := client.GetUsage(ctx)
if err != nil {
	return err
}
for _, row := range usage.Value.Allowance {
	fmt.Printf("%s (%s): %d of %d left\n", row.Feature, row.Window, row.Remaining, row.Limit)
}

import com.getlingara.client.model.AllowanceRow;
import com.getlingara.client.model.Usage;

Usage usage = client.getUsage().body();
for (AllowanceRow row : usage.getAllowance()) {
  System.out.println(
      row.getFeature()
          + " ("
          + row.getWindow()
          + "): "
          + row.getRemaining()
          + " of "
          + row.getLimit()
          + " left");
}

val usage = client.getUsage().body
for (row in usage.allowance) {
    println("${row.feature} (${row.window}): ${row.remaining} of ${row.limit} left")
}

usage = client.get_usage.value
usage.allowance.each { |row| puts "#{row.feature} (#{row.window}): #{row.remaining} of #{row.limit} left" }
puts "#{usage.ledger.calls} calls this month" if usage.ledger

foreach ($client->getUsage()->value->getAllowance() as $row) {
    echo $row->getFeature(), ': ', $row->getRemaining(), ' of ', $row->getLimit(), ' left this ', $row->getWindow(), "\n";
}

Vous préférez une bibliothèque ? Consultez la section Bibliothèques.