Gift cards

Gift cards — outstanding balance (liability) and issued value, by status and customer.

10 fields — 7 dimensions, 3 metrics. Date clauses (SINCE, UNTIL, DURING) use createdAt.

The live, authoritative list is always GET /v1/datasets — this page is regenerated from the same catalog, but the endpoint reflects exactly what is deployed.

Query it

FROM gift_cards
  SHOW gift_card_count
  GROUP BY enabled
  SINCE -30d

See Querying with SoloQL for the language.

This dataset is queryable through SoloQL; it has no record-retrieval endpoint.

Fields

FieldTypeRoleDescription
enabledbooleandimensionWhether the gift card is enabled.
customer_namestringdimensionName of the customer the gift card belongs to.
currencystringdimensionCurrency of the gift card balance.
created_atdatedimensionWhen the gift card was created.
expires_ondatedimensionWhen the gift card expires.
deactivated_atdatedimensionWhen the gift card was deactivated.
gift_card_countnumbermetricNumber of gift cards in the group (document count — value_count on createdAt). Sums across stores.
balancemoneymetricCurrent remaining balance — the store's outstanding gift card liability.
initial_valuemoneymetricInitial value the gift card was issued with.
storestringdimensionThe shop the record belongs to. Filter with WHERE store IN ('Shop name') or GROUP BY store.