Runs a report and returns it as a file.

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

No permission required.

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

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 PowerShell TypeScript C# Python

cURL

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

$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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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();

dotnet add package WinkPg.Api.Client

C# (SDK)

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)

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();

pip install winkpg-api

Python (SDK)

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)

pip install requests

Python (raw HTTP)

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()

Parameters

Name	In	Type	Description
`reportId` required	path	string	The report id, from the catalog.
`format` required	query	ReportFileFormat	The file format: `Csv` (the default) or `Xlsx`. The catalog lists each report's formats.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`startDate` required	string (date)	The first calendar day to include, for example `2026-03-01`. Read as a day in `timeZoneId`, and included whole.
`endDate` required	string (date)	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 and StartDate meet conditions.
`timeZoneId` required	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. nullablemax length 64
`merchantId` required	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` required	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

This request body has no documented fields.