# POST /api/transactions/reports/statistics

Counts and totals the transactions matching a filter, three ways.

Folds every transaction matching the filter into count and total amount, grouped by
transaction type, by payment type and by result code. The three groupings partition the
same rows, so each one sums to the overall figures.

**Operation ID:** `transactionStatisticsGetStatistics`

## Authorization

Requires: Transactions.Reports, merchant scope.

Requires API key scope: `transactions:read`

Required permissions:
- `Transactions.Reports`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The filter tree, in the same vocabulary the transaction continuation list accepts, plus the
optional UTC creation-time bounds and the optional merchant scope.

**Content type:** `application/json`

Schema: [`TransactionStatisticsRequestDto`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TransactionStatisticsRequestDto.md)

Properties:
- `merchantId` (string(uuid)): Optional merchant to restrict the aggregate to. When omitted, the result covers every merchant the caller is entitled to see. A merchant outside the caller's scope yields an empty result rather than an error, because the caller is not entitled to learn whether it exists. (nullable)
- `minCreationTime` (string(date-time)): Inclusive lower bound on the transaction's creation time, in UTC. (nullable)
- `maxCreationTime` (string(date-time)): Exclusive upper bound on the transaction's creation time, in UTC. (nullable)
- `filter` ([FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)): The filter tree, in the same vocabulary the transaction continuation list accepts, including its virtual fields (`PaymentMethod`, `DisplayGuid`, `EntryMode`, `SettlementBatchId` and the rest), which are resolved server-side exactly as the list resolves them.
  Fields:
  - `logic` ([FilterLogic](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterLogic.md))
    Values:
    - `And`
    - `Or`
  - `rules` (array<[FilterRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterRule.md)>): (nullable)
  - `groups` (array<[FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable)

_Example: One merchant, one month_

Aggregates one merchant's transactions created in September 2026. Both bounds are UTC: the minimum is inclusive and the maximum exclusive, the same convention the transaction list applies.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z"
}
```

_Example: Sales only, every merchant in scope_

Aggregates only sales across every merchant the caller can see, for the same month. The filter uses the vocabulary the transaction list accepts, so a filter built for the list can be sent here unchanged and describes the same rows.

```json
{
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z",
  "filter": {
    "logic": "And",
    "rules": [
      {
        "field": "TransactionType",
        "operator": "Equals",
        "value": "Sale"
      }
    ]
  }
}
```

**Content type:** `text/json`

Schema: [`TransactionStatisticsRequestDto`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TransactionStatisticsRequestDto.md)

Properties:
- `merchantId` (string(uuid)): Optional merchant to restrict the aggregate to. When omitted, the result covers every merchant the caller is entitled to see. A merchant outside the caller's scope yields an empty result rather than an error, because the caller is not entitled to learn whether it exists. (nullable)
- `minCreationTime` (string(date-time)): Inclusive lower bound on the transaction's creation time, in UTC. (nullable)
- `maxCreationTime` (string(date-time)): Exclusive upper bound on the transaction's creation time, in UTC. (nullable)
- `filter` ([FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)): The filter tree, in the same vocabulary the transaction continuation list accepts, including its virtual fields (`PaymentMethod`, `DisplayGuid`, `EntryMode`, `SettlementBatchId` and the rest), which are resolved server-side exactly as the list resolves them.
  Fields:
  - `logic` ([FilterLogic](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterLogic.md))
    Values:
    - `And`
    - `Or`
  - `rules` (array<[FilterRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterRule.md)>): (nullable)
  - `groups` (array<[FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable)

_Example: One merchant, one month_

Aggregates one merchant's transactions created in September 2026. Both bounds are UTC: the minimum is inclusive and the maximum exclusive, the same convention the transaction list applies.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z"
}
```

_Example: Sales only, every merchant in scope_

Aggregates only sales across every merchant the caller can see, for the same month. The filter uses the vocabulary the transaction list accepts, so a filter built for the list can be sent here unchanged and describes the same rows.

```json
{
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z",
  "filter": {
    "logic": "And",
    "rules": [
      {
        "field": "TransactionType",
        "operator": "Equals",
        "value": "Sale"
      }
    ]
  }
}
```

**Content type:** `application/*+json`

Schema: [`TransactionStatisticsRequestDto`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TransactionStatisticsRequestDto.md)

Properties:
- `merchantId` (string(uuid)): Optional merchant to restrict the aggregate to. When omitted, the result covers every merchant the caller is entitled to see. A merchant outside the caller's scope yields an empty result rather than an error, because the caller is not entitled to learn whether it exists. (nullable)
- `minCreationTime` (string(date-time)): Inclusive lower bound on the transaction's creation time, in UTC. (nullable)
- `maxCreationTime` (string(date-time)): Exclusive upper bound on the transaction's creation time, in UTC. (nullable)
- `filter` ([FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)): The filter tree, in the same vocabulary the transaction continuation list accepts, including its virtual fields (`PaymentMethod`, `DisplayGuid`, `EntryMode`, `SettlementBatchId` and the rest), which are resolved server-side exactly as the list resolves them.
  Fields:
  - `logic` ([FilterLogic](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterLogic.md))
    Values:
    - `And`
    - `Or`
  - `rules` (array<[FilterRule](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterRule.md)>): (nullable)
  - `groups` (array<[FilterGroup](https://devportal.signapay-sbx.winkpg.io/docs/api/models/FilterGroup.md)>): (nullable)

_Example: One merchant, one month_

Aggregates one merchant's transactions created in September 2026. Both bounds are UTC: the minimum is inclusive and the maximum exclusive, the same convention the transaction list applies.

```json
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z"
}
```

_Example: Sales only, every merchant in scope_

Aggregates only sales across every merchant the caller can see, for the same month. The filter uses the vocabulary the transaction list accepts, so a filter built for the list can be sent here unchanged and describes the same rows.

```json
{
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z",
  "filter": {
    "logic": "And",
    "rules": [
      {
        "field": "TransactionType",
        "operator": "Equals",
        "value": "Sale"
      }
    ]
  }
}
```

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`TransactionStatisticsDto`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TransactionStatisticsDto.md)

Properties:
- `transactionCount` (integer(int64)): The number of matching transactions folded into the three groupings.
- `totalAmount` (number(double)): The sum of the matching transactions' totals.
- `truncated` (boolean): Whether the scan stopped at `MaxScannedTransactions` before the filtered set ran out, in which case every figure is over a prefix of that set.
- `byTransactionType` (array<[TransactionStatisticsBucketDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TransactionStatisticsBucketDto.md)>): Count and total per transaction type, keyed by the `TransactionType` member name (`Sale`, `Authorization`, `Return`, ...), ordered by descending count. (nullable)
  Fields of each item:
  - `key` (string): The bucket key: the enum member name of the grouping this bucket belongs to. (nullable)
  - `count` (integer(int64)): The number of matching transactions in the bucket.
  - `totalAmount` (number(double)): The sum of the bucket's transaction totals.
- `byPaymentType` (array<[TransactionStatisticsBucketDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TransactionStatisticsBucketDto.md)>): Count and total per payment method, keyed by the `PaymentMethodsGranular` member name (`Visa`, `MasterCard`, `Check`, `AlternativePayment`, ...), resolved by the same rule every transaction read surface uses, ordered by descending count. (nullable)
  Fields of each item:
  - `key` (string): The bucket key: the enum member name of the grouping this bucket belongs to. (nullable)
  - `count` (integer(int64)): The number of matching transactions in the bucket.
  - `totalAmount` (number(double)): The sum of the bucket's transaction totals.
- `byResultCode` (array<[TransactionStatisticsBucketDto](https://devportal.signapay-sbx.winkpg.io/docs/api/models/TransactionStatisticsBucketDto.md)>): Count and total per gateway result, keyed by the `ResultCode` member name (`Ok`, `Declined`, ...), ordered by descending count. A transaction that recorded no response at all falls in the bucket keyed `NoResultKey`. (nullable)
  Fields of each item:
  - `key` (string): The bucket key: the enum member name of the grouping this bucket belongs to. (nullable)
  - `count` (integer(int64)): The number of matching transactions in the bucket.
  - `totalAmount` (number(double)): The sum of the bucket's transaction totals.

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": null,
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 401

Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 403

Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 404

Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": null,
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": null,
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": null
  }
}
```

### 500

Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 501

Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": null,
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": null
  }
}
```

### Errors

These statuses answer with the error envelope outlined below.

- `400`: Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
- `401`: Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
- `403`: Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
- `404`: Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
- `500`: Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
- `501`: Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
- `default`: The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.signapay-sbx.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))
  Fields:
  - `code` (string): (nullable)
  - `message` (string): (nullable)
  - `details` (string): (nullable)
  - `data` (object): (nullable)
  - `validationErrors` (array<[RemoteServiceValidationErrorInfo](https://devportal.signapay-sbx.winkpg.io/docs/api/models/RemoteServiceValidationErrorInfo.md)>): (nullable)

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": null,
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

## Authentication

- `ApiKey`

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a TransactionStatisticsRequestDto. See the Request body section below for its fields.

These blocks send the One merchant, one month example. The other examples follow under Other request examples.

Aggregates one merchant's transactions created in September 2026. Both bounds are UTC: the minimum is inclusive and the maximum exclusive, the same convention the transaction list applies.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/transactions/reports/statistics" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z"
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/reports/statistics' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, TransactionStatisticsApi } from '@winkpg/winkpg-api';

const api = new TransactionStatisticsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.transactionStatisticsGetStatistics({
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/transactions/reports/statistics', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "merchantId": "00000000-0000-0000-0000-000000000001",
    "minCreationTime": "2026-09-01T00:00:00Z",
    "maxCreationTime": "2026-10-01T00:00:00Z"
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new TransactionStatisticsApi(config);
var body = JsonSerializer.Deserialize<TransactionStatisticsRequestDto>("""
    {
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "minCreationTime": "2026-09-01T00:00:00Z",
      "maxCreationTime": "2026-10-01T00:00:00Z"
    }
    """);

var result = await api.TransactionStatisticsGetStatisticsAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/transactions/reports/statistics");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "minCreationTime": "2026-09-01T00:00:00Z",
      "maxCreationTime": "2026-10-01T00:00:00Z"
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.TransactionStatisticsApi(client)
    body = winkpg_api.TransactionStatisticsRequestDto.from_dict({
      "merchantId": "00000000-0000-0000-0000-000000000001",
      "minCreationTime": "2026-09-01T00:00:00Z",
      "maxCreationTime": "2026-10-01T00:00:00Z"
    })
    result = api.transaction_statistics_get_statistics(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "merchantId": "00000000-0000-0000-0000-000000000001",
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/reports/statistics",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## Other request examples

Each example below is one request, shown in every language with the same placeholders.

### Sales only, every merchant in scope

Aggregates only sales across every merchant the caller can see, for the same month. The filter uses the vocabulary the transaction list accepts, so a filter built for the list can be sent here unchanged and describes the same rows.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/transactions/reports/statistics" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z",
  "filter": {
    "logic": "And",
    "rules": [
      {
        "field": "TransactionType",
        "operator": "Equals",
        "value": "Sale"
      }
    ]
  }
}'
```

#### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z",
  "filter": {
    "logic": "And",
    "rules": [
      {
        "field": "TransactionType",
        "operator": "Equals",
        "value": "Sale"
      }
    ]
  }
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/reports/statistics' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

#### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, TransactionStatisticsApi } from '@winkpg/winkpg-api';

const api = new TransactionStatisticsApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.transactionStatisticsGetStatistics({
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z",
  "filter": {
    "logic": "And",
    "rules": [
      {
        "field": "TransactionType",
        "operator": "Equals",
        "value": "Sale"
      }
    ]
  }
});
```

#### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/transactions/reports/statistics', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "minCreationTime": "2026-09-01T00:00:00Z",
    "maxCreationTime": "2026-10-01T00:00:00Z",
    "filter": {
      "logic": "And",
      "rules": [
        {
          "field": "TransactionType",
          "operator": "Equals",
          "value": "Sale"
        }
      ]
    }
  }),
});

const data = await response.json();
```

#### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new TransactionStatisticsApi(config);
var body = JsonSerializer.Deserialize<TransactionStatisticsRequestDto>("""
    {
      "minCreationTime": "2026-09-01T00:00:00Z",
      "maxCreationTime": "2026-10-01T00:00:00Z",
      "filter": {
        "logic": "And",
        "rules": [
          {
            "field": "TransactionType",
            "operator": "Equals",
            "value": "Sale"
          }
        ]
      }
    }
    """);

var result = await api.TransactionStatisticsGetStatisticsAsync(body);
```

#### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/transactions/reports/statistics");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "minCreationTime": "2026-09-01T00:00:00Z",
      "maxCreationTime": "2026-10-01T00:00:00Z",
      "filter": {
        "logic": "And",
        "rules": [
          {
            "field": "TransactionType",
            "operator": "Equals",
            "value": "Sale"
          }
        ]
      }
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

#### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.TransactionStatisticsApi(client)
    body = winkpg_api.TransactionStatisticsRequestDto.from_dict({
      "minCreationTime": "2026-09-01T00:00:00Z",
      "maxCreationTime": "2026-10-01T00:00:00Z",
      "filter": {
        "logic": "And",
        "rules": [
          {
            "field": "TransactionType",
            "operator": "Equals",
            "value": "Sale"
          }
        ]
      }
    })
    result = api.transaction_statistics_get_statistics(body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "minCreationTime": "2026-09-01T00:00:00Z",
  "maxCreationTime": "2026-10-01T00:00:00Z",
  "filter": {
    "logic": "And",
    "rules": [
      {
        "field": "TransactionType",
        "operator": "Equals",
        "value": "Sale"
      }
    ]
  }
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/reports/statistics",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.