Get credit stats

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

Returns spending totals, daily breakdowns, per-module/service/user splits, Lasso table usage, and the company’s money-display configuration for the requested period.

Query parameters

from

string

required

Start date, inclusive (YYYY-MM-DD).

string

required

End date, inclusive (YYYY-MM-DD). Must be on or after from, and the range may span at most 1830 days (~5 years).

Response

period

object

Show Requested period

from

string

Echoed start date.

string

Echoed end date.

summary

object

Show Summary metrics

total_spent

number

Total credits spent in the period.

previous_period_spent

number

Credits spent in the equal-length window immediately before from.

previous_period_change_pct

number | null

Percentage change vs. the previous period. null when the prior window had zero spend (no baseline).

monthly_allocation

number

Monthly credit allocation for the company.

period_end

string | null

End of the current billing period (ISO 8601), if known.

cost_per_credit

object | null

Show Cost per credit (omitted when no monthly fee is configured)

amount

number

Money value of one credit.

currency

string

CZK or EUR.

monthly_fee

number

Configured monthly fee used for the conversion.

monthly_credits

number

Allocation used as the denominator.

daily

array

Show Daily breakdown

date

string

Day (YYYY-MM-DD).

total

number

Total credits spent that day.

by_module

object

Map of module_key to credits spent.

by_user

object

Map of user_id to credits spent.

by_module

array

Show Per-module totals

module_key

string

Module (e.g. lasso, saddle, scout).

total

number

Credits spent by the module.

by_service

array

Show Per-service totals

service_type

string

Service (e.g. ai_field, product_import, subtitles).

total

number

Credits spent by the service.

by_user

array

Show Per-user totals

user_id

string

User identifier, or system for non-user activity.

total

number

Credits spent by the user.

lasso

object

Show Lasso (product extraction) usage

credits_spent

number

Total Lasso credits spent in the period.

products_enhanced

number

Sum of the current total_products across tables that had Lasso usage in the period — a snapshot of table sizes, not a count of products enhanced during the period.

credits_per_product

number | null

credits_spent / products_enhanced using those snapshot counts.

by_table

array

Show Per-table usage

table_id

string | null

Extraction job id, or null for tables that were deleted after the spend.

name

string

Table name.

total

number

Credits spent on the table.

products

number

Current product count for the table.

currency_config

object

Show Money-display configuration

monthly_fee_czk

number | null

Configured monthly fee in CZK.

monthly_fee_eur

number | null

Configured or auto-computed monthly fee in EUR.

monthly_credits

number

Monthly credit allocation.

auto_eur

boolean

Whether the EUR fee is auto-computed from a Stripe subscription.

For row-level transaction export, use Get credit usage. For the live balance, use Get credit balance.

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

Errors

Status	Meaning
400	Missing/invalid `from` or `to`, `from` after `to`, or range larger than 1830 days
401	Invalid or missing API key
500	Server or database error

List ProductsList catalog products with pagination and filtering

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 parameters

​Response

​Errors

Query parameters

Response

Errors