---
title: "Aggregate Transaction Data"
method: POST
path: "/v1/web/transaction/aggregate"
tags: ["Transaction Analytics"]
---

# Aggregate Transaction Data

`POST /v1/web/transaction/aggregate`

## Request body

- object
  - `accountId` string, required — DashFi Account ID
  - `userGroupId` string — Filter by group
  - `bucket` union, required
    - object
      - `field` union, required
        - 'amountDirection'
        - 'cardId'
        - 'cardName'
        - 'cardStatus'
        - 'cardType'
        - 'currencyCode'
        - 'declineReason'
        - 'isDeclined'
        - 'isRewardsTransaction'
        - 'issuerAndUseCase'
        - 'merchantCategoryCode'
        - 'merchantCountryCode'
        - 'standardizedMerchantName'
        - 'termName'
        - 'transactionCategoryName'
        - 'transactionStatus'
    - object
      - `field` 'transactionCreatedAt', required
      - `timeframe` union, required
        - 'day'
        - 'month'
  - `value` union, required
    - object
      - `field` union, required
        - 'settledAmount'
        - 'totalRefundedAmount'
        - 'amount'
      - `aggregateMethod` union, required
        - 'avg'
        - 'sum'
    - object
      - `aggregateMethod` 'count', required
  - `filters` union[]
    - union
      - object
        - `field` 'transactionCreatedAt', required
        - `value` object, required
          - `before` string, date-time
          - `after` string, date-time
      - object
        - `field` union, required
          - 'isDeclined'
          - 'isRewardsTransaction'
        - `value` boolean, required
      - object
        - `field` 'merchantCategoryCode', required
        - `value` string[], required
      - object
        - `field` union, required
          - 'amountDirection'
          - 'cardId'
          - 'cardName'
          - 'cardStatus'
          - 'cardType'
          - 'currencyCode'
          - 'declineReason'
          - 'issuerAndUseCase'
          - 'merchantCountryCode'
          - 'standardizedMerchantName'
          - 'termName'
          - 'transactionCategoryName'
          - 'transactionStatus'
        - `value` string[], required

## Response `200`

Default Response

- object
  - `items` object[], required
    - `bucket` union, required
      - string
      - boolean
    - `value` string, required

## Other responses

- `400` — Default Response
- `401` — The access to this resource has been denied
- `403` — The access to this resource is forbidden
- `default` — Catch-all error response for any unexpected internal errors

---

[API](https://skmtc.net/funneldash/apis/surface-web-api.md) · [All operations](https://skmtc.net/funneldash/apis/surface-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/funneldash/surface-web-api/revisions/ac700d65f443/schema)