---
title: "Statistics:Management"
method: GET
path: "/v2/statistics/management"
tags: ["Statistics"]
---

# Statistics:Management

`GET /v2/statistics/management`

Get statistical information regarding your transactions. You can set several filters and you can group the the results in max 2 levels. Note always one group by is required. If you supply a merchantCode you need to have access to that merchant.

## Query parameters

- `startDate` string, date, required
- `endDate` string, date, required
- `groupBy[0]` 'paymentMethod' | 'paymentMethodBrand' | 'paymentMethodGroup' | 'day' | 'month' | 'year' | 'tool' | 'info' | 'merchantCode' | 'ipAddress' | 'extra1' | 'week' | 'turnoverGroup' | 'extra2' | 'extra3' | 'object' | 'paymentSession' | 'hour' | 'startTime' | 'amount' | 'createdAt' | 'orderId' | 'countryCode' | 'countryName' | 'stopTime' | 'service' | 'reference' | 'terminal' | 'paymentProfile' | 'description' | 'reconciliationStatus' | 'reconciliationReceivedAt' | 'paymentType' | 'direction' | 'collecting' | 'customerKey' | 'customerId' | 'customerName' | 'customerEmail' | 'paymentVerificationMethod' | 'merchant' | 'completedTime' | 'createdTimestamp' | 'startedTimestamp' | 'completedTimestamp' | 'limit' | 'page', required
- `groupBy[1]` 'paymentMethod' | 'paymentMethodBrand' | 'paymentMethodGroup' | 'day' | 'month' | 'year' | 'tool' | 'info' | 'merchantCode' | 'ipAddress' | 'extra1' | 'week' | 'turnoverGroup' | 'extra2' | 'extra3' | 'object' | 'paymentSession' | 'hour' | 'startTime' | 'amount' | 'createdAt' | 'orderId' | 'countryCode' | 'countryName' | 'stopTime' | 'service' | 'reference' | 'terminal' | 'paymentProfile' | 'description' | 'reconciliationStatus' | 'reconciliationReceivedAt' | 'paymentType' | 'direction' | 'collecting' | 'customerKey' | 'customerId' | 'customerName' | 'customerEmail' | 'paymentVerificationMethod' | 'merchant' | 'completedTime' | 'createdTimestamp' | 'startedTimestamp' | 'completedTimestamp' | 'limit' | 'page'
- `amount` object
  - `gte` integer — Get results that are greater than or equals to the provided value.
  - `gt` integer — Get results that are greater than the provided value.
  - `eq` integer — Get results that equal the provided value.
  - `lt` integer — Get results that are less than the provided value.
  - `lte` integer — Get results that are less than or equals to the provided value.
- `country` object
  - `eq` integer — Get results that equal the provided value.
  - `neq` integer — Get results that does not equal the provided value.
  - `in` integer — Get results that exist in the provided values.
  - `nin` integer — Get results that do not exists in the provided values.
  - `lte` integer — Get results that are less than or equals to the provided value.
- `createdAt` object
  - `gte` string, date-time — Get results that are greater than or equals to the provided value.
  - `gt` string, date-time — Get results that are greater than the provided value.
  - `eq` string, date-time — Get results that equal the provided value.
  - `lt` string, date-time — Get results that are less than the provided value.
  - `lte` string, date-time — Get results that are less than or equals to the provided value.
- `day` object
  - `eq` integer — Get results that equal the provided value.
  - `neq` integer — Get results that does not equal the provided value.
  - `in` integer — Get results that exist in the provided values.
  - `nin` integer — Get results that do not exists in the provided values.
- `extra1` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `like` string — Get results that contain the provided value.
  - `isNull` string — Get results that is null or not null
- `extra2` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `like` string — Get results that contain the provided value.
  - `isNull` string — Get results that is null or not null
- `extra3` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `like` string — Get results that contain the provided value.
  - `isNull` string — Get results that contain the provided value.
- `hour` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
- `info` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `like` string — Get results that contain the provided value.
  - `isNull` string — Get results that is null or not null
- `ipAddress` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `like` string — Get results that contain the provided value.
- `merchant` string
- `merchantCode` string
- `month` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
- `object` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `like` string — Get results that contain the provided value.
  - `isNull` string — Get results that is null or not null
- `orderId` object
  - `eq` integer — Get results that equal the provided value.
  - `neq` integer — Get results that does not equal the provided value.
  - `in` integer — Get results that exist in the provided values.
  - `nin` integer — Get results that do not exists in the provided values.
- `paymentMethodBrand` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
- `paymentMethod` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
- `paymentSession` string
- `reference` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
  - `isNull` string — Get results that is null or not null
- `service` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
- `startTime` object
  - `gte` string — Get results that are greater than or equals to the provided value.
  - `gt` string — Get results that are greater than the provided value.
  - `eq` string — Get results that equal the provided value.
  - `lt` string — Get results that are less than the provided value.
  - `lte` string — Get results that are less than or equals to the provided value.
- `stopTime` object
  - `gte` string — Get results that are greater than or equals to the provided value.
  - `gt` string — Get results that are greater than the provided value.
  - `eq` string — Get results that equal the provided value.
  - `lt` string — Get results that are less than the provided value.
  - `lte` string — Get results that are less than or equals to the provided value.
- `tool` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `like` string — Get results that contain the provided value.
  - `isNull` string — Get results that is null or not null
- `turnoverGroup` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
- `terminal` object
  - `eq` string — Get results that equal the provided value.
  - `neq` string — Get results that does not equal the provided value.
  - `in` string — Get results that exist in the provided values.
  - `nin` string — Get results that do not exists in the provided values.
  - `isNull` string — Get results that is null or not null
- `week` object
  - `eq` integer — Get results that equal the provided value.
  - `neq` integer — Get results that does not equal the provided value.
  - `in` integer — Get results that exist in the provided values.
  - `nin` integer — Get results that do not exists in the provided values.
- `year` object
  - `eq` integer — Get results that equal the provided value.
  - `neq` integer — Get results that does not equal the provided value.
  - `in` integer — Get results that exist in the provided values.
  - `nin` integer — Get results that do not exists in the provided values.

## Response `200`

OK

- StatisticStatisticsManagementOutput — Represents grouped management statistics.
  - `statistics` StatisticStatisticManagementOutputSingleGroupOutput[], nullable — The data of the group
    - `id` union — The identifier of the group
      - string
      - integer
    - `label` string — The label of the group
    - `data` StatisticStatisticManagementOutputPaymentMethodOutput[] — The data of the group
      - `volume` integer — All amount values summed from the stats
      - `costs` integer — Total costs
      - `transactions` integer — Number of transactions
      - `averagePaidAmount` integer — Average paid amount
      - `internalVolume` integer — Total volume internally (Pay. is collecting)
      - `externalVolume` integer — Total volume externally
      - `totalVolume` integer — Total volume

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `422` — Unprocessable entity, see response body for more information
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.dev/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)