# POST /api/reports/{reportId}/run

Runs a report and returns its rows.

The range is calendar days read in `timeZoneId`, from the start of `startDate` to the
end of `endDate`; the response echoes the UTC window that was covered. A run that would
return more than 10,000 rows is refused rather than truncated.

**Operation ID:** `reportsRun`

## Authorization

No permission required.

Requires API key scope: `reports`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| reportId | path | yes | string | The report id, from the catalog. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The date range, time zone, merchant and filters to run with.

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

Schema: [`ReportRunRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/ReportRunRequestDto.md)

Properties:
- `startDate` (string(date)) required: The first calendar day to include, for example `2026-03-01`. Read as a day in  `timeZoneId`, and included whole.
- `endDate` (string(date)) required: The last calendar day to include, for example `2026-03-31`. Included whole: the run covers  up to the first instant of the next day in `timeZoneId`. Must not be before  `startDate`, and the range may cover at most 366 days. Conditional: When EndDate >= StartDate.
- `timeZoneId` (string): The IANA time zone the dates are calendar days in, for example `America/Los_Angeles`.  Reports that group rows by day group them by this zone's day. Optional: the dates are UTC days  when it is omitted. Conditional: When TimeZoneId is not empty. (nullable, max length 64)
- `merchantId` (string(uuid)): Narrows the run to one merchant the caller can read. Optional: the run covers every merchant  the caller can read when it is omitted. Refused for a report whose catalog entry does not  support a merchant, and for a merchant outside the caller's scope. Conditional: When MerchantId is not null. (nullable)
- `filters` (object): The report's filters, keyed by the names its parameters route lists. A filter that allows  multiple values takes an array; every other filter takes a single value. Optional. Conditional: When Filters is not null. (nullable)

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

Schema: [`ReportRunRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/ReportRunRequestDto.md)

Properties:
- `startDate` (string(date)) required: The first calendar day to include, for example `2026-03-01`. Read as a day in  `timeZoneId`, and included whole.
- `endDate` (string(date)) required: The last calendar day to include, for example `2026-03-31`. Included whole: the run covers  up to the first instant of the next day in `timeZoneId`. Must not be before  `startDate`, and the range may cover at most 366 days. Conditional: When EndDate >= StartDate.
- `timeZoneId` (string): The IANA time zone the dates are calendar days in, for example `America/Los_Angeles`.  Reports that group rows by day group them by this zone's day. Optional: the dates are UTC days  when it is omitted. Conditional: When TimeZoneId is not empty. (nullable, max length 64)
- `merchantId` (string(uuid)): Narrows the run to one merchant the caller can read. Optional: the run covers every merchant  the caller can read when it is omitted. Refused for a report whose catalog entry does not  support a merchant, and for a merchant outside the caller's scope. Conditional: When MerchantId is not null. (nullable)
- `filters` (object): The report's filters, keyed by the names its parameters route lists. A filter that allows  multiple values takes an array; every other filter takes a single value. Optional. Conditional: When Filters is not null. (nullable)

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

Schema: [`ReportRunRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/ReportRunRequestDto.md)

Properties:
- `startDate` (string(date)) required: The first calendar day to include, for example `2026-03-01`. Read as a day in  `timeZoneId`, and included whole.
- `endDate` (string(date)) required: The last calendar day to include, for example `2026-03-31`. Included whole: the run covers  up to the first instant of the next day in `timeZoneId`. Must not be before  `startDate`, and the range may cover at most 366 days. Conditional: When EndDate >= StartDate.
- `timeZoneId` (string): The IANA time zone the dates are calendar days in, for example `America/Los_Angeles`.  Reports that group rows by day group them by this zone's day. Optional: the dates are UTC days  when it is omitted. Conditional: When TimeZoneId is not empty. (nullable, max length 64)
- `merchantId` (string(uuid)): Narrows the run to one merchant the caller can read. Optional: the run covers every merchant  the caller can read when it is omitted. Refused for a report whose catalog entry does not  support a merchant, and for a merchant outside the caller's scope. Conditional: When MerchantId is not null. (nullable)
- `filters` (object): The report's filters, keyed by the names its parameters route lists. A filter that allows  multiple values takes an array; every other filter takes a single value. Optional. Conditional: When Filters is not null. (nullable)

## Responses

### 200

OK

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

Schema: [`ReportRunResultDto`](https://devportal.demo.winkpg.io/docs/api/models/ReportRunResultDto.md)

Properties:
- `reportId` (string): The report id that ran. (nullable)
- `startUtc` (string(date-time)): The first instant the run covered, inclusive, in UTC.
- `endUtc` (string(date-time)): The end of the window the run covered, exclusive, in UTC: the first instant of the day after  the last requested day.
- `timeZoneId` (string): The time zone the dates were read in, or `null` when they were UTC days. (nullable)
- `merchantId` (string(uuid)): The merchant the run was narrowed to, or `null` when it was not narrowed. (nullable)
- `columns` (array<[ReportColumnDto](https://devportal.demo.winkpg.io/docs/api/models/ReportColumnDto.md)>): The columns, in display order. (nullable)
  Fields of each item:
  - `field` (string): The key the column's value is stored under in each row. Stable once published. (nullable)
  - `label` (string): The column's display label. (nullable)
  - `fieldType` ([ReportColumnFieldType](https://devportal.demo.winkpg.io/docs/api/models/ReportColumnFieldType.md)): The type of the column's values.
    Values:
    - `String`: Text.
    - `Integer`: A whole number.
    - `Decimal`: A number with a fractional part, such as an amount.
    - `Boolean`: true or false.
    - `DateTime`: An ISO 8601 date and time.
    - `Date`: An ISO 8601 calendar date.
    - `Guid`: A GUID.
    - `Other`: Any other value. Read it as text.
  - `format` (string): A display format hint, for example `C` for currency or `d` for a short date, when the  report provides one. Values in rows are never pre-formatted. (nullable)
  - `isVisible` (boolean): Whether the column is shown by default.
  - `aggregates` (array<[ColumnAggregateType](https://devportal.demo.winkpg.io/docs/api/models/ColumnAggregateType.md)>): The totals the report shows for this column, when it shows any. (nullable)
    Values:
    - `Sum`: Sum of all values in the column.
    - `Average`: Average of all values in the column.
    - `Count`: Count of rows (non-null values).
    - `Min`: Minimum value in the column.
    - `Max`: Maximum value in the column.
- `rows` (array<object>): The rows. Each row is keyed by the `field` of its columns; a row may omit a column that  has no value. (nullable)
- `rowCount` (integer(int32)): The number of rows.

### 403

You do not hold the report's permission.

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

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

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

### 401

Unauthorized

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

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

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

### 400

The request is invalid, names a filter the report does not define
(`Reports:UnknownFilter`) or a value that does not fit it
(`Reports:InvalidFilterValue`), names a merchant for a report that cannot be narrowed to
one (`Reports:MerchantFilterNotSupported`), or would return too many rows
(`Reports:RowLimitExceeded`).

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

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

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.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"
        ]
      }
    ]
  }
}
```

### 404

The report does not exist or is not available to your tenant (`Reports:ReportNotFound`),
or the merchant does not exist or is not one you can read (`Reports:MerchantNotInScope`).

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

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

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.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"
  }
}
```

### 501

Not Implemented

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

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

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

### 500

Internal Server Error

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

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

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.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.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

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

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

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.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"
  }
}
```

### 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.demo.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.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

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

## 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 ReportRunRequestDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/reports/{reportId}/run" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2026-01-01",
  "endDate": "2026-01-01"
}'
```

### PowerShell

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

$body = @'
{
  "startDate": "2026-01-01",
  "endDate": "2026-01-01"
}
'@

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

### TypeScript (SDK)

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

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

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

const { data } = await api.reportsRun("REPORT_ID", {
  "startDate": "2026-01-01",
  "endDate": "2026-01-01"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/reports/{reportId}/run', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "startDate": "2026-01-01",
    "endDate": "2026-01-01"
  }),
});

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 ReportsApi(config);
var body = JsonSerializer.Deserialize<ReportRunRequestDto>("""
    {
      "startDate": "2026-01-01",
      "endDate": "2026-01-01"
    }
    """);

var result = await api.ReportsRunAsync("REPORT_ID", 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/reports/{reportId}/run");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "startDate": "2026-01-01",
      "endDate": "2026-01-01"
    }
    """, 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.ReportsApi(client)
    body = winkpg_api.ReportRunRequestDto.from_dict({
      "startDate": "2026-01-01",
      "endDate": "2026-01-01"
    })
    result = api.reports_run("REPORT_ID", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "startDate": "2026-01-01",
  "endDate": "2026-01-01"
}

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

## See also

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