/Data/KPIDrillthrough
Request Method
POST
URL Parameters
None. Note that a request body is required; see the next heading.
Request Body Details
This endpoint uses the following properties of the request body:
Required. Logical name of the KPI. This must be a KPI that supports detail listings; that is, it must implement the %OnGetListingSQL() callback.
Specifies the range of cells in the KPI for which you are requesting a detail listing. The value of this property should be a string with the form “startRow,startColumn,endRow,endColumn”. (Note that numbering for rows and columns should be 1-based.)
Specifies the KPI values of the rows for which you are requesting a detail listing, as a comma-separated list. Any comma within these values should be replaced with a backslash character (\). If no property of the KPI is configured as the KPI’s value, this property can specify the series name.
Specifies the number of the column by which the detail listing’s results should be sorted. If you do not wish to sort the results, specify 0.
Specifies the order by which the results should be sorted: ascending ("ASC") or descending ("DESC").
Name of the listing to display.
An array that describes the filters which should be applied to the detail listing. Each filter should correspond to a JSON object in the array. The filter object should include the following properties:
-
name — the logical name of the filter (for example: [aged].[h1].[agegroup])
-
value — the user-specified value for the filter (for example: [0 to 29])
Example Request
-
Request Method:
POST
-
Request URL:
https://localhost/biserver/api/deepsee/v3/sales/Data/KPIDrillthrough
For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
-
Request Body:
{ "KPI": "HoleFoods/KPISQL", "ITEMS": "Donuts (dozen)", "SORTCOL": 2, "SORTDIR": "DESC", "FILTERS": [ { "name": "City", "value": "Santiago" } ] }
Example Response
{
"Info": {
"KPI": "HoleFoods/KPISQL",
"RANGE": "",
"ITEMS": "Donuts (dozen)",
"SORTCOL": 2,
"SORTDIR": "DESC",
"LISTING": "",
"FILTERS": [
{
"name": "City",
"value": "Santiago"
}
],
"TimeStamp": "2025-09-24 08:49:06",
"Error": ""
},
"Result": {
"children": [
{
"ID": 1978,
"DateOfSale": "12/01/2025",
"Product": "SKU-101"
},
{
"ID": 1979,
"DateOfSale": "12/01/2025",
"Product": "SKU-192"
},
{
"ID": 1980,
"DateOfSale": "12/01/2025",
"Product": "SKU-192"
},
...]
}
}
For information that applies to all response objects, see Notes on the Response Objects.
