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

Runs a report and returns it as a file.

Takes the same body as a run. The file is streamed in the response, named in its
`Content-Disposition` header.

**Operation ID:** `reportsExport`

## Authorization

No permission required.

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| reportId | path | yes | string | The report id, from the catalog. |
| format | query | no | ReportFileFormat | The file format: `Csv` (the default) or `Xlsx`. The catalog lists each report's formats. |
| 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`

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.
- `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.
- `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.

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

Schema: `ReportRunRequestDto`

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.
- `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.
- `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.

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

Schema: `ReportRunRequestDto`

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.
- `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.
- `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.

## Responses

### 200

OK

**Content type:** `text/csv`

Schema type: `string(binary)`

### 403

You do not hold the report's permission.

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

The request is invalid, the report does not export in that format
(`Reports:ExportFormatNotSupported`), 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`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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. See the error-code reference in this document's description for the values `error.code` can take.

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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`

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.
- `title` (string) required: A short, human-readable summary of the problem type.
- `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.
- `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`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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}/export" \
  -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}/export' `
    -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.reportsExport("REPORT_ID", {
  "startDate": "2026-01-01",
  "endDate": "2026-01-01"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/reports/{reportId}/export', {
  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.ReportsExportAsync("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}/export");
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_export("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}/export",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

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