Ottieni la quota rimanente

Parametri

Lingara-Versionheaderstringfacoltativo

La versione dell'API con cui rispondere a questa richiesta. Senza di essa, un token di accesso riceve la versione a cui è associato il suo client e una richiesta senza token riceve la versione corrente. La versione ancora in sviluppo si raggiunge solo indicandola qui. Una versione sconosciuta risponde 400 con il codice api_version_unknown. GET /v1/versions elenca le versioni.

Risposte

200 La tua quota

allowancearray of AllowanceRowobbligatorio

featurestringobbligatorio

windowstringobbligatorio

limitintegerobbligatorio

usedintegerobbligatorio

remainingintegerobbligatorio

reset_atinteger | nullfacoltativo

ledgerUsageLedger | nullfacoltativo

Le chiamate e le unità di questo client dalla mezzanotte UTC del primo del mese. Presente solo per un client a consumo, le cui chiamate non usano alcuna quota. Può essere indietro fino a cinque secondi rispetto alla tua ultima chiamata.

sincestringobbligatorio

callsintegerobbligatorio

unitsintegerobbligatorio

Errori

410application/json

La versione dell'API con cui si risponde a questa richiesta è stata dismessa. Invia una versione supportata in Lingara-Version, oppure associa il client a un'altra versione.

4XXapplication/json

La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

503application/json · text/plain

Il servizio è temporaneamente non disponibile; riprova dopo il numero di secondi indicato in Retry-After. Durante la manutenzione il corpo è testo semplice anziché l'envelope di errore.

5XXapplication/json

La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

codestringobbligatorio

Perché la richiesta è stata rifiutata, come codice stabile su cui diramare la logica: per esempio insufficient_scope (403), rate_limited (429) e, per un client con fatturazione a consumo, spend_cap_reached (402) e metered_billing_inactive (402).

errorstringobbligatorio

Esempio

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";
}

Preferisci una libreria? Vedi la sezione Librerie.