Získat statistiky kreditů

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}`);
}

{
  "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

from

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ěď

period

object

Zobrazit Zvolené období

from

string

Počáteční datum.

string

Koncové datum.

summary

object

Zobrazit Souhrnné metriky

total_spent

number

Celkem utracené kredity za období.

previous_period_spent

number

Kredity utracené ve stejně dlouhém okně bezprostředně před from.

previous_period_change_pct

number | null

Procentuální změna oproti předchozímu období. null, pokud předchozí okno nemělo žádnou útratu (chybí základna).

monthly_allocation

number

Měsíční alokace kreditů společnosti.

period_end

string | null

Konec aktuálního fakturačního období (ISO 8601), pokud je znám.

cost_per_credit

object | null

Zobrazit Cena za kredit (vynecháno, pokud není nastaven měsíční poplatek)

amount

number

Peněžní hodnota jednoho kreditu.

currency

string

CZK nebo EUR.

monthly_fee

number

Nastavený měsíční poplatek použitý pro převod.

monthly_credits

number

Alokace použitá jako jmenovatel.

daily

array

Zobrazit Denní rozpad

date

string

Den (YYYY-MM-DD).

total

number

Celkem utracené kredity v daný den.

by_module

object

Mapa module_key na utracené kredity.

by_user

object

Mapa user_id na utracené kredity.

by_module

array

Zobrazit Součty podle modulu

module_key

string

Modul (např. lasso, saddle, scout).

total

number

Kredity utracené modulem.

by_service

array

Zobrazit Součty podle služby

service_type

string

Služba (např. ai_field, product_import, subtitles).

total

number

Kredity utracené službou.

by_user

array

Zobrazit Součty podle uživatele

user_id

string

Identifikátor uživatele, nebo system pro systémovou aktivitu.

total

number

Kredity utracené uživatelem.

lasso

object

Zobrazit Využití Lasso (extrakce produktů)

credits_spent

number

Celkem utracené Lasso kredity za období.

products_enhanced

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í.

credits_per_product

number | null

credits_spent / products_enhanced z těchto aktuálních počtů.

by_table

array

Zobrazit Využití podle tabulky

table_id

string | null

ID extrakční úlohy, nebo null u tabulek smazaných po útratě.

name

string

Název tabulky.

total

number

Kredity utracené na tabulce.

products

number

Aktuální počet produktů v tabulce.

currency_config

object

Zobrazit Konfigurace zobrazení v penězích

monthly_fee_czk

number | null

Nastavený měsíční poplatek v CZK.

monthly_fee_eur

number | null

Nastavený nebo automaticky vypočtený měsíční poplatek v EUR.

monthly_credits

number

Měsíční alokace kreditů.

auto_eur

boolean

Zda je poplatek v EUR automaticky vypočten z předplatného Stripe.

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}`);
}

{
  "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

Předchozí

Seznam produktůNačtení stránkovaného seznamu produktů z katalogu s filtrováním

Další

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}`);
}

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

​Query parametry

​Odpověď

​Chyby

Query parametry

Odpověď

Chyby