> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Faceting
> Learn how to aggregate and count values in your search results
export const CtaCallout = props => {
const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
const handleCtaClick = () => {
if (typeof window === "undefined" || !trackingEvent) {
return;
}
try {
window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
detail: {
name: trackingEvent,
href
}
}));
} catch {}
try {
window.posthog?.capture?.(trackingEvent, {
href
});
} catch {}
const gaPayload = {
cta_href: href
};
try {
window.gtag?.("event", trackingEvent, gaPayload);
} catch {}
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: trackingEvent,
...gaPayload
});
} catch {}
};
const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
const linkRel = isExternal ? rel : undefined;
return ;
};
Faceting gives you total counts for any field in your results. It helps you build filters and understand how your data is grouped. You can:
* Count transactions per currency
* See how many transactions are in each status
* Group balances by ledger or identity
* Break transactions into date or amount ranges
***
## Quick start
Here's a basic faceting request that shows the total counts for the `status` and `currency` fields:
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"facet_by": "status,currency"
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{ q: '*', facet_by: 'status,currency' },
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{Q: "*", FacetBy: "status,currency"},
blnkgo.Transactions,
)
```
```json Response expandable theme={"system"}
{
"facet_counts": [
{
"counts": [
{
"count": 1000,
"highlighted": "APPLIED",
"value": "APPLIED"
},
{
"count": 1500,
"highlighted": "INFLIGHT",
"value": "INFLIGHT"
}
{
"count": 500,
"highlighted": "REJECTED",
"value": "REJECTED"
}
],
"field_name": "status",
"stats": {
"total_values": 1
}
},
{
"counts": [
{
"count": 876,
"highlighted": "GBP",
"value": "GBP"
},
{
"count": 821,
"highlighted": "EUR",
"value": "EUR"
},
{
"count": 803,
"highlighted": "USD",
"value": "USD"
}
],
"field_name": "currency",
"stats": {
"total_values": 3
}
}
]
}
```
| **Field** | **Description** |
| :------------- | :------------------------------------------- |
| `field_name` | The field being faceted. |
| `value` | A unique value found in that field. |
| `count` | Number of documents that have this value. |
| `counts` | The full list of values and their counts. |
| `total_values` | How many unique values exist for this field. |
***
## Combining faceting with filters
Faceting becomes more powerful when combined with filters. You can facet on one field while filtering on others to analyze specific subsets of your data.
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"filter_by": "currency:=USD",
"facet_by": "status"
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{ q: '*', filter_by: 'currency:=USD', facet_by: 'status' },
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{
Q: "*",
FilterBy: "currency:=USD",
FacetBy: "status",
},
blnkgo.Transactions,
)
```
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/balances" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"filter_by": "identity_id:=idt_28f25ef6-2e0d-4fa6-891c-37fc409d654e",
"facet_by": "currency"
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{
q: '*',
filter_by: 'identity_id:=idt_28f25ef6-2e0d-4fa6-891c-37fc409d654e',
facet_by: 'currency',
},
'balances',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{
Q: "*",
FilterBy: "identity_id:=idt_28f25ef6-2e0d-4fa6-891c-37fc409d654e",
FacetBy: "currency",
},
blnkgo.Balances,
)
```
The example above allows you to answer questions like:
* "Of all my USD transactions, how many are in each status?"
* "For this specific customer, how many balances do they have in each currency?""
***
## Faceting on metadata fields
You can also facet on metadata objects.
```bash cURL wrap theme={"system"}
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/search/transactions" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "*",
"facet_by": "meta_data.transaction_type,meta_data.payment_method"
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Search.search(
{
q: '*',
facet_by: 'meta_data.transaction_type,meta_data.payment_method',
},
'transactions',
);
```
```go Go wrap theme={"system"}
results, resp, err := client.Search.SearchDocument(
blnkgo.SearchParams{
Q: "*",
FacetBy: "meta_data.transaction_type,meta_data.payment_method",
},
blnkgo.Transactions,
)
```
Always use dot notation to access nested metadata fields: `meta_data.field_name`
***
## Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.
To ask questions or discuss issues, please [contact us](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).
Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.