Je resterende tegoed ophalen

Parameters

Lingara-Versionheaderstringoptioneel

De API-versie waaronder dit verzoek wordt beantwoord. Zonder deze krijgt een toegangstoken de versie waaraan zijn client is gekoppeld, en een verzoek zonder token de huidige versie. De versie die nog in ontwikkeling is, bereik je alleen door die hier te noemen. Een onbekende versie geeft 400 met code api_version_unknown. GET /v1/versions toont de versies.

Antwoorden

200 Je tegoed

allowancearray of AllowanceRowverplicht

featurestringverplicht

windowstringverplicht

limitintegerverplicht

usedintegerverplicht

remainingintegerverplicht

reset_atinteger | nulloptioneel

ledgerUsageLedger | nulloptioneel

De aanroepen en eenheden van deze client sinds middernacht UTC op de eerste van de maand. Alleen aanwezig bij een client met verbruiksafrekening, waarvan de aanroepen geen tegoed verbruiken. Kan tot vijf seconden achterlopen op je laatste aanroep.

sincestringverplicht

callsintegerverplicht

unitsintegerverplicht

Fouten

410application/json

De API-versie waaronder dit verzoek wordt beantwoord, is stopgezet. Stuur een ondersteunde versie mee in Lingara-Version, of koppel de client aan een andere versie.

4XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

503application/json · text/plain

De dienst is tijdelijk niet beschikbaar; probeer het opnieuw na het aantal seconden in Retry-After. Tijdens onderhoud is de body platte tekst in plaats van de foutenvelop.

5XXapplication/json

Het verzoek is geweigerd. code geeft de reden aan en error beschrijft die in woorden.

codestringverplicht

Waarom het verzoek is geweigerd, als stabiele code om op te vertakken: bijvoorbeeld insufficient_scope (403), rate_limited (429) en, voor een client met verbruiksafrekening, spend_cap_reached (402) en metered_billing_inactive (402).

errorstringverplicht

Voorbeeld

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

Liever een bibliotheek? Zie de sectie Bibliotheken.