GET insights/reports/by-code-name/{reportCodeName}

Next, call this. You will get detailed information about a report, including what filters and output columns it has.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
reportCodeName string Required

Body Parameters

None.

Response Information

Resource Description

Next, call this. You will get detailed information about a report, including what filters and output columns it has.

ReportSchema
NameDescriptionTypeAdditional information
CodeName A human readable unique identifier for the report string None.
DisplayName The user friendly name string None.
Description A description of what the report does; Contains markup string None.
Filters Possible filters you can send Collection of ReportFilterSchema None.
OutputColumns Possible output columns you can request Collection of ReportColumnSchema None.
OrderByOptions Codenames of columns which are available to order the output data by Collection of string None.

Response Formats

application/json, text/json

Sample: 
{
  "CodeName": "product-stock-levels",
  "DisplayName": "Product Stock Levels",
  "Description": "<p>This report shows current stock levels for all products across your stock locations.</p>",
  "Filters": [
    {
      "CodeName": "SKU",
      "FilterType": "Text",
      "DefaultDisplayName": "Product SKU"
    },
    {
      "CodeName": "StockLocationId",
      "FilterType": "ForeignKey",
      "DefaultDisplayName": "Stock Location",
      "DropdownCodeName": "StockLocations"
    },
    {
      "CodeName": "LastUpdatedDate",
      "FilterType": "Date",
      "DefaultDisplayName": "Last Updated"
    },
    {
      "CodeName": "QuantityInStock",
      "FilterType": "Numerical",
      "DefaultDisplayName": "Quantity in Stock"
    }
  ],
  "OutputColumns": [
    {
      "CodeName": "ProductId",
      "OutputType": "Integer",
      "DefaultDisplayName": "Product ID"
    },
    {
      "CodeName": "SKU",
      "OutputType": "String",
      "DefaultDisplayName": "Product SKU"
    },
    {
      "CodeName": "ProductName",
      "OutputType": "String",
      "DefaultDisplayName": "Product Name"
    },
    {
      "CodeName": "StockLocation",
      "OutputType": "String",
      "DefaultDisplayName": "Stock Location"
    },
    {
      "CodeName": "QuantityInStock",
      "OutputType": "Integer",
      "DefaultDisplayName": "Quantity Available"
    },
    {
      "CodeName": "LastUpdated",
      "OutputType": "DateTime",
      "DefaultDisplayName": "Last Updated"
    }
  ],
  "OrderByOptions": [
    "SKU",
    "ProductName",
    "QuantityInStock",
    "LastUpdated"
  ]
}