Waiting for engine...
Skip to main content

Knowledge Hub Management APIs - consumption

Updated 
Toggle Pane

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

consumption

Consumption usage reporting

Get usage

Return every metering dimension's total for the requested scope.

Each of repository_id, knowledge_base_id and source_id is a repeatable filter (repeated values are OR'd together); leave all three unset for account-wide totals. date_from/date_to bound the range and default to the last 7 local days; timezone (IANA name) governs those defaults and the daily bucket boundaries. The response carries totals plus per-day series for data ingested (bytes and document count), retrieval calls, and persisted storage, along with the previous period's totals for comparison.

Results are scoped to the caller's Boomi tenant via the token's account claim.

Required privileges: KNOWLEDGE_HUB_CONSUMPTION_READ.

Authorizations:
HTTPBearer
query Parameters
Array of Repository Id (strings) or Repository Id (null) (Repository Id)

Repository filter; repeatable, OR'd

Array of Knowledge Base Id (strings) or Knowledge Base Id (null) (Knowledge Base Id)

KB filter; repeatable, OR'd

Array of Source Id (strings) or Source Id (null) (Source Id)

Source filter; repeatable, OR'd

Date From (string) or Date From (null) (Date From)

Range start; defaults to 7 local days back

Date To (string) or Date To (null) (Date To)

Range end; defaults to now, in timezone

timezone
string (Timezone)
Default: "UTC"

IANA timezone name governing date-range defaults and daily-bucket boundaries

limit
integer (Limit) [ 1 .. 1000 ]
Default: 500

Page size shared by daily_ingestion_volume, daily_retrieval_calls and daily_persisted_storage

offset
integer (Offset) >= 0
Default: 0

Page offset shared by daily_ingestion_volume, daily_retrieval_calls and daily_persisted_storage

Responses

Response Schema: application/json
date_from_ms
required
integer (Date From Ms)
date_to_ms
required
integer (Date To Ms)
timezone
required
string (Timezone)
required
object (ByteSizeInfo)

Exact byte count paired with its human-readable display.

Named ByteSizeInfo rather than ByteSize to avoid shadowing pydantic.ByteSize (a built-in int subclass with its own .human_readable()), which would otherwise collide for any consumer importing both.

required
object (PeriodOverPeriodDelta)

A dimension's current total against the immediately-preceding period of equal length (Figma node 29034-190508 — the +14.9%/-3.6% pill next to each KPI tile).

:param current: Raw total for the requested range (never the rounded display value). :param previous: The same raw total for the preceding period. :param delta_pct: (current - previous) / previous * 100, rounded to 1 decimal. None when previous is 0 — undefined, not infinite.

required
object (ByteSizeInfo)

Exact byte count paired with its human-readable display.

Named ByteSizeInfo rather than ByteSize to avoid shadowing pydantic.ByteSize (a built-in int subclass with its own .human_readable()), which would otherwise collide for any consumer importing both.

required
object (PeriodOverPeriodDelta)

A dimension's current total against the immediately-preceding period of equal length (Figma node 29034-190508 — the +14.9%/-3.6% pill next to each KPI tile).

:param current: Raw total for the requested range (never the rounded display value). :param previous: The same raw total for the preceding period. :param delta_pct: (current - previous) / previous * 100, rounded to 1 decimal. None when previous is 0 — undefined, not infinite.

retrieval_calls
required
integer (Retrieval Calls)
required
object (PeriodOverPeriodDelta)

A dimension's current total against the immediately-preceding period of equal length (Figma node 29034-190508 — the +14.9%/-3.6% pill next to each KPI tile).

:param current: Raw total for the requested range (never the rounded display value). :param previous: The same raw total for the preceding period. :param delta_pct: (current - previous) / previous * 100, rounded to 1 decimal. None when previous is 0 — undefined, not infinite.

embedding_model_calls
required
integer (Embedding Model Calls)
required
object (PeriodOverPeriodDelta)

A dimension's current total against the immediately-preceding period of equal length (Figma node 29034-190508 — the +14.9%/-3.6% pill next to each KPI tile).

:param current: Raw total for the requested range (never the rounded display value). :param previous: The same raw total for the preceding period. :param delta_pct: (current - previous) / previous * 100, rounded to 1 decimal. None when previous is 0 — undefined, not infinite.

ai_enrichment_calls
required
integer (Ai Enrichment Calls)
required
object (PeriodOverPeriodDelta)

A dimension's current total against the immediately-preceding period of equal length (Figma node 29034-190508 — the +14.9%/-3.6% pill next to each KPI tile).

:param current: Raw total for the requested range (never the rounded display value). :param previous: The same raw total for the preceding period. :param delta_pct: (current - previous) / previous * 100, rounded to 1 decimal. None when previous is 0 — undefined, not infinite.

required
object (DailyIngestionVolumePage)

A page of DailyIngestionVolume entries. total is the full day-count of the requested range, independent of limit/offset.

:param items: The page's entries.

required
object (DailyRetrievalVolumePage)

A page of DailyRetrievalVolume entries, sharing DailyIngestionVolumePage's limit/offset page over the same calendar-day range.

:param items: The page's entries.

required
object (DailyPersistedStoragePage)

A page of DailyPersistedStorage entries, sharing DailyIngestionVolumePage's limit/offset page over the same calendar-day range.

:param items: The page's entries.

Account (string) or Account (null) (Account)
Array of Repository Ids (strings) or Repository Ids (null) (Repository Ids)
Array of Knowledge Base Ids (strings) or Knowledge Base Ids (null) (Knowledge Base Ids)
Array of Source Ids (strings) or Source Ids (null) (Source Ids)

Response samples

Content type
application/json
{
  • "account": "boomi-account-1",
  • "ai_enrichment_calls": 0,
  • "ai_enrichment_calls_period_over_period": {
    • "current": 0,
    • "previous": 0
    },
  • "daily_ingestion_volume": {
    • "items": [
      ],
    • "limit": 31,
    • "offset": 0,
    • "total": 7
    },
  • "daily_persisted_storage": {
    • "items": [
      ],
    • "limit": 31,
    • "offset": 0,
    • "total": 7
    },
  • "daily_retrieval_calls": {
    • "items": [
      ],
    • "limit": 31,
    • "offset": 0,
    • "total": 7
    },
  • "data_ingested": {
    • "bytes": 3145728,
    • "display": {
      }
    },
  • "data_ingested_period_over_period": {
    • "current": 3145728,
    • "delta_pct": 100,
    • "previous": 1572864
    },
  • "data_persisted": {
    • "bytes": 54525952,
    • "display": {
      }
    },
  • "data_persisted_period_over_period": {
    • "current": 54525952,
    • "delta_pct": 4,
    • "previous": 52428800
    },
  • "date_from_ms": 1769904000000,
  • "date_to_ms": 1770508800000,
  • "embedding_model_calls": 460,
  • "embedding_model_calls_period_over_period": {
    • "current": 460,
    • "delta_pct": 15,
    • "previous": 400
    },
  • "retrieval_calls": 120,
  • "retrieval_calls_period_over_period": {
    • "current": 120,
    • "delta_pct": 20,
    • "previous": 100
    },
  • "timezone": "UTC"
}