WinkPG Docs

View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`ReportRunResultDto`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The columns and rows a report run produced, with the window it actually covered.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

reportId required

string

The report id that ran. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

startUtc required

string (date-time)

The first instant the run covered, inclusive, in UTC.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

endUtc required

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

timeZoneId required

string

The time zone the dates were read in, or `null` when they were UTC days. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

merchantId required

string (uuid)

The merchant the run was narrowed to, or `null` when it was not narrowed. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

columns required

array of ReportColumnDto array of ReportColumnDto

The columns, in display order. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each ReportColumnDto:

Field Type Description

field required

string

The key the column's value is stored under in each row. Stable once published. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

label required

string

The column's display label. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fieldType required

ReportColumnFieldType ReportColumnFieldType

The type of the column's values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isVisible required

boolean

Whether the column is shown by default.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

aggregates required

array of ColumnAggregateType array of ColumnAggregateType

The totals the report shows for this column, when it shows any. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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

This body has no documented fields.

rows required

array of object array of

The rows. Each row is keyed by the `field` of its columns; a row may omit a column that has no value. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

rowCount required

integer (int32)

The number of rows.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.