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

Next, call this, if your report has foreign key filters. This will give you dropdown values. It is recommended that you cache these on your end.

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

Next, call this, if your report has foreign key filters. This will give you dropdown values. It is recommended that you cache these on your end.

Collection of ReportDropdown
NameDescriptionTypeAdditional information
CodeName Which filter does this apply to? string None.
Rows id => name pairs Collection of ReportDropdownRow None.

Response Formats

application/json, text/json

Sample: 
{
  "Dropdowns": [
    {
      "CodeName": "StockLocations",
      "Rows": [
        {
          "Id": 1,
          "Name": "Main Warehouse"
        },
        {
          "Id": 2,
          "Name": "London Distribution Center"
        },
        {
          "Id": 3,
          "Name": "Manchester Fulfillment"
        }
      ]
    },
    {
      "CodeName": "Channels",
      "Rows": [
        {
          "Id": 1,
          "Name": "Amazon UK"
        },
        {
          "Id": 2,
          "Name": "eBay"
        },
        {
          "Id": 3,
          "Name": "Shopify Store"
        }
      ]
    }
  ]
}