POST insights/reports/by-code-name/{reportCodeName}/preview

Use this to test your report export call. Returns the first 20 rows as json data.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
reportCodeName Unique identifier for the report in question string Required

Body Parameters

Optional filters and configuration for the report

ReportExportRequest
NameDescriptionTypeAdditional information
ColumnHeaderType What type of column headers to use? human readable, or codenames? Human readable strings match the display name of the column. Codenames are more useful for machine readable output CsvColumnHeaderType None.
DateFilters Optional. If specified, these will be applied to filters of type Date in the schema Collection of ReportExportDateFilter None.
NumericalFilters If specified, these will be applied to filters of type Numerical in the schema Collection of ReportExportNumericalFilter None.
TextFilters If specified, these will be applied to filters of type Text in the schema. Collection of ReportExportTextFilter None.
ForeignKeyFilters If specified, these will be applied to filters of type ForeignKey in the schema. Values can be taken from the dropdowns endpoints. Collection of ReportExportForeignKeyFilter None.
OrderBy Used to specify which order by option you want to use string None.
OrderDescending Optionally swap the ordering direction to descending boolean None.

Request Formats

application/json, text/json

Sample: 
{
  "ColumnHeaderType": "HumanReadable",
  "DateFilters": [
    {
      "FilterCodeName": "LastOrderedDate",
      "MinDateUtc": "2026-04-20T18:03:06.6240055Z",
      "MaxDateUtc": "2026-05-20T18:03:06.6240055Z"
    }
  ],
  "NumericalFilters": [
    {
      "FilterCodeName": "Price",
      "Operator": "GreaterThanOrEqualTo",
      "Value": 10.0
    }
  ],
  "TextFilters": [
    {
      "FilterCodeName": "SKU",
      "Operator": "Wildcard",
      "Expression": "ABC*"
    },
    {
      "FilterCodeName": "Supplier",
      "Operator": "Equals",
      "Expression": "Acme Corp"
    }
  ],
  "ForeignKeyFilters": [
    {
      "FilterCodeName": "ChannelId",
      "Ids": [
        1,
        2,
        3
      ]
    }
  ],
  "OrderBy": "SKU",
  "OrderDescending": false
}

Response Information

Resource Description

Use this to test your report export call. Returns the first 20 rows as json data.

ReportPreviewResponse
NameDescriptionTypeAdditional information
TimeZone What timezone did the report run under? This should be your account timezone. string None.
TotalResults The total number of results that would be returned in a full export integer None.
Rows The preview rows (up to 20 results) Collection of Dictionary of string [key] and Object [value] None.

Response Formats

application/json, text/json

Sample: 
{
  "TimeZone": "(UTC) Dublin, Edinburgh, Lisbon, London",
  "TotalResults": 1247,
  "Rows": [
    {
      "ProductId": 1001,
      "SKU": "WIDGET-BLU-001",
      "ProductName": "Blue Widget",
      "StockLocation": "Main Warehouse",
      "QuantityInStock": 150,
      "LastUpdated": "2026-01-15T14:30:00"
    },
    {
      "ProductId": 1002,
      "SKU": "GADGET-RED-XL",
      "ProductName": "Red Gadget XL",
      "StockLocation": "London Distribution Center",
      "QuantityInStock": 87,
      "LastUpdated": "2026-01-16T09:15:00"
    },
    {
      "ProductId": 1003,
      "SKU": "TOOL-SET-PRO",
      "ProductName": "Professional Tool Set",
      "StockLocation": "Main Warehouse",
      "QuantityInStock": 42,
      "LastUpdated": "2026-01-14T16:45:00"
    }
  ]
}