POST /api/v202607/dynamicReporting/runTempReport

Executes a temporary report based on the provided KQL query and returns the resulting data.

RunTempReportV202607 Permissions: Reports (Run)

Request Headers

Header	Value	Required	Description
ECI-ApiKey	string	Yes	Your API key. See Authentication.
Content-Type	application/json	Yes	All requests must specify JSON content type, including the request body.

Request Body

WattsTempReportRequest

Property	Description	Type
kql	KQL query to execute as a temporary report. Required	string

Example Request Body application/json

{  "kql": "string"
}

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

EdxQueryResultV202606

Property Description Type

columns EdxColumnV202606[]

EdxColumnV202606 properties

Property Description Type

dataType The logical value type used by clients for formatting and data behavior. string

description Human-readable description of the column, when documented in the schema. string

name The result alias or schema field name displayed for this column. string

presentation EdxPresentationV202606

EdxPresentationV202606 properties

Property	Description	Type
entityType	Entity addressed by an `entityLink`, such as `place` or `meter`. Null for presentation formats that do not address an entity.	string
format	Presentation strategy. Currently the only supported value is `entityLink`.	string

relatedFields Unit fields needed to display this field. EdxRelatedFieldV202606[]

EdxRelatedFieldV202606 properties

Property	Description	Type
name	Name of the related unit field.	string
type	Display role: `unit` or `unitCode`.	string

queryTimeMs integer (int64)

render EdxRenderV202606

EdxRenderV202606 properties

Property	Description	Type
accumulate	Optional running-total flag.	boolean
chartType	Chart kind: columnchart, barchart, timechart, linechart, areachart, piechart, scatterchart, etc.	string
kind	Optional sub-kind, e.g. “stacked”.	string
series	Optional series (split-by) columns.	string[]
title	Optional chart title.	string
xColumn	Optional explicit category (x-axis) column.	string
yColumns	Optional explicit value (y-axis) columns.	string[]

rowCount integer (int32)

rows Rows, each an array of cell values aligned positionally to EnergyCap.DTO.V202606.EdxQueryResultDTO.Columns. array[]

truncated True when results were capped and more rows exist. boolean

Example Response application/json

{  "columns": [
    {    "dataType": "string",    "description": "string",    "name": "string",    "presentation": {      "entityType": "string",      "format": "string"
    },    "relatedFields": [
      {      "name": "string",      "type": "string"
    }
    ]
  }
  ],  "queryTimeMs": 1,  "render": {    "accumulate": false,    "chartType": "string",    "kind": "string",    "series": [
      "string"
    ],    "title": "string",    "xColumn": "string",    "yColumns": [
      "string"
    ]
  },  "rowCount": 1,  "rows": [
    [
    {}
  ]
  ],  "truncated": false
}