GET insights/reports

Call this first. This gives you a list of all reports that your API user has access to. You will need to set the correct report permissions on your API user. Reports that your API user does not have permission to run will be hidden.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Call this first. This gives you a list of all reports that your API user has access to. You will need to set the correct report permissions on your API user. Reports that your API user does not have permission to run will be hidden.

Collection of ReportSummaryResponse
NameDescriptionTypeAdditional information
CodeName A human readable unique identifier for the report string None.
DisplayName The user friendly name string None.
Summary A short summary of what the report does string None.

Response Formats

application/json, text/json

Sample: 
{
  "Reports": [
    {
      "CodeName": "product-stock-levels",
      "DisplayName": "Product Stock Levels",
      "Summary": "View current stock levels across all products and stock locations"
    },
    {
      "CodeName": "order-summary",
      "DisplayName": "Order Summary Report",
      "Summary": "Detailed order information including status, dates, and customer details"
    },
    {
      "CodeName": "sales-by-channel",
      "DisplayName": "Sales by Channel",
      "Summary": "Breakdown of sales performance across all sales channels"
    }
  ]
}