Kredity
Získat statistiky kreditů
Načtení agregovaných statistik využití kreditů za období, připravených pro BI nástroje jako Power BI nebo Looker.
GET
/
credits
/
stats
const stats = await client.credits.stats({
from: "2025-01-01",
to: "2025-03-31",
});
console.log(`Total spent: ${stats.summary.total_spent} credits`);
for (const m of stats.by_module) {
console.log(`${m.module_key}: ${m.total}`);
}
stats = client.credits.stats(
from_="2025-01-01",
to="2025-03-31",
)
print(f"Total spent: {stats['summary']['total_spent']} credits")
for m in stats["by_module"]:
print(f"{m['module_key']}: {m['total']}")
curl -X GET "https://hub.banditshq.com/api/v1/credits/stats?from=2025-01-01&to=2025-03-31" \
-H "Authorization: Bearer lasso_..."
{
"period": { "from": "2025-01-01", "to": "2025-03-31" },
"summary": {
"total_spent": 4200,
"previous_period_spent": 3800,
"previous_period_change_pct": 10.5,
"monthly_allocation": 50000,
"period_end": "2025-04-18T00:00:00.000Z",
"cost_per_credit": {
"amount": 0.02,
"currency": "EUR",
"monthly_fee": 1000,
"monthly_credits": 50000
}
},
"daily": [
{
"date": "2025-01-01",
"total": 120,
"by_module": { "lasso": 120 },
"by_user": { "5f0e...": 120 }
}
],
"by_module": [{ "module_key": "lasso", "total": 3000 }],
"by_service": [{ "service_type": "ai_field", "total": 1500 }],
"by_user": [{ "user_id": "5f0e...", "total": 800 }],
"lasso": {
"credits_spent": 3000,
"products_enhanced": 450,
"credits_per_product": 6.67,
"by_table": [
{
"table_id": "9b81...",
"name": "Summer catalog",
"total": 800,
"products": 120
}
]
},
"currency_config": {
"monthly_fee_czk": 25000,
"monthly_fee_eur": 1000,
"monthly_credits": 50000,
"auto_eur": false
}
}
Vrací souhrn útraty, denní rozpad, rozdělení podle modulu/služby/uživatele, využití Lasso tabulek a konfiguraci zobrazení v penězích pro zvolené období.
Query parametry
string
povinné
Počáteční datum, včetně (
YYYY-MM-DD).string
povinné
Koncové datum, včetně (
YYYY-MM-DD). Musí být stejné nebo pozdější než from a rozsah může být nejvýše 1830 dní (~5 let).Odpověď
object
Zobrazit Souhrnné metriky
Zobrazit Souhrnné metriky
number
Celkem utracené kredity za období.
number
Kredity utracené ve stejně dlouhém okně bezprostředně před
from.number | null
Procentuální změna oproti předchozímu období.
null, pokud předchozí okno nemělo žádnou útratu (chybí základna).number
Měsíční alokace kreditů společnosti.
string | null
Konec aktuálního fakturačního období (ISO 8601), pokud je znám.
array
array
array
array
object
Zobrazit Využití Lasso (extrakce produktů)
Zobrazit Využití Lasso (extrakce produktů)
number
Celkem utracené Lasso kredity za období.
number
Součet aktuálního
total_products napříč tabulkami, které měly v období Lasso útratu — jde o aktuální stav velikosti tabulek, nikoli počet produktů zpracovaných v daném období.number | null
credits_spent / products_enhanced z těchto aktuálních počtů.object
Pro export jednotlivých transakcí použijte Získat využití kreditů. Pro aktuální zůstatek použijte Získat zůstatek kreditů.
const stats = await client.credits.stats({
from: "2025-01-01",
to: "2025-03-31",
});
console.log(`Total spent: ${stats.summary.total_spent} credits`);
for (const m of stats.by_module) {
console.log(`${m.module_key}: ${m.total}`);
}
stats = client.credits.stats(
from_="2025-01-01",
to="2025-03-31",
)
print(f"Total spent: {stats['summary']['total_spent']} credits")
for m in stats["by_module"]:
print(f"{m['module_key']}: {m['total']}")
curl -X GET "https://hub.banditshq.com/api/v1/credits/stats?from=2025-01-01&to=2025-03-31" \
-H "Authorization: Bearer lasso_..."
{
"period": { "from": "2025-01-01", "to": "2025-03-31" },
"summary": {
"total_spent": 4200,
"previous_period_spent": 3800,
"previous_period_change_pct": 10.5,
"monthly_allocation": 50000,
"period_end": "2025-04-18T00:00:00.000Z",
"cost_per_credit": {
"amount": 0.02,
"currency": "EUR",
"monthly_fee": 1000,
"monthly_credits": 50000
}
},
"daily": [
{
"date": "2025-01-01",
"total": 120,
"by_module": { "lasso": 120 },
"by_user": { "5f0e...": 120 }
}
],
"by_module": [{ "module_key": "lasso", "total": 3000 }],
"by_service": [{ "service_type": "ai_field", "total": 1500 }],
"by_user": [{ "user_id": "5f0e...", "total": 800 }],
"lasso": {
"credits_spent": 3000,
"products_enhanced": 450,
"credits_per_product": 6.67,
"by_table": [
{
"table_id": "9b81...",
"name": "Summer catalog",
"total": 800,
"products": 120
}
]
},
"currency_config": {
"monthly_fee_czk": 25000,
"monthly_fee_eur": 1000,
"monthly_credits": 50000,
"auto_eur": false
}
}
Chyby
| Stav | Význam |
|---|---|
| 400 | Chybějící/neplatné from nebo to, from po to, nebo rozsah větší než 1830 dní |
| 401 | Neplatný nebo chybějící API klíč |
| 500 | Chyba serveru nebo databáze |
⌘I
const stats = await client.credits.stats({
from: "2025-01-01",
to: "2025-03-31",
});
console.log(`Total spent: ${stats.summary.total_spent} credits`);
for (const m of stats.by_module) {
console.log(`${m.module_key}: ${m.total}`);
}
stats = client.credits.stats(
from_="2025-01-01",
to="2025-03-31",
)
print(f"Total spent: {stats['summary']['total_spent']} credits")
for m in stats["by_module"]:
print(f"{m['module_key']}: {m['total']}")
curl -X GET "https://hub.banditshq.com/api/v1/credits/stats?from=2025-01-01&to=2025-03-31" \
-H "Authorization: Bearer lasso_..."
{
"period": { "from": "2025-01-01", "to": "2025-03-31" },
"summary": {
"total_spent": 4200,
"previous_period_spent": 3800,
"previous_period_change_pct": 10.5,
"monthly_allocation": 50000,
"period_end": "2025-04-18T00:00:00.000Z",
"cost_per_credit": {
"amount": 0.02,
"currency": "EUR",
"monthly_fee": 1000,
"monthly_credits": 50000
}
},
"daily": [
{
"date": "2025-01-01",
"total": 120,
"by_module": { "lasso": 120 },
"by_user": { "5f0e...": 120 }
}
],
"by_module": [{ "module_key": "lasso", "total": 3000 }],
"by_service": [{ "service_type": "ai_field", "total": 1500 }],
"by_user": [{ "user_id": "5f0e...", "total": 800 }],
"lasso": {
"credits_spent": 3000,
"products_enhanced": 450,
"credits_per_product": 6.67,
"by_table": [
{
"table_id": "9b81...",
"name": "Summer catalog",
"total": 800,
"products": 120
}
]
},
"currency_config": {
"monthly_fee_czk": 25000,
"monthly_fee_eur": 1000,
"monthly_credits": 50000,
"auto_eur": false
}
}