GET /api/v202606/edx/schema/preview/{table}

Returns a sample of rows from a single table.

PreviewV202606

Equivalent to running {table} | take {limit}. An unknown table name or any execution failure returns 400 Bad Request with the reason in the problem detail. Requires the Edx feature flag.

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.

Path Parameters

Name	Description	Type	Required
table	Name of the table to preview; must be a queryable EDX table.	string	Required

Query Parameters

Name	Description	Type	Required
limit	Maximum number of rows to return. Defaults to 100 and is capped at 500.	integer (int32)	Optional

Responses

200 Sample rows from the requested table. 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 string

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

displayFormat Optional purely cosmetic rendering variant for columns that share a EnergyCap.DTO.V202606.EdxColumnDto.DataType but are drawn differently. No column declares one today — anything that changed more than rendering became a EnergyCap.DTO.V202606.EdxColumnDto.DataType instead. string

name 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",    "displayFormat": "string",    "name": "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
}

400 The table name is unknown or the preview failed; see the problem detail. The request was malformed or contains invalid parameters. Check the request body and query parameters.

Response Body Parameters

ProblemDetails

Property	Description	Type
detail		string
instance		string
status		integer (int32)
title		string
type		string

Example Response application/json

{  "detail": "string",  "instance": "string",  "status": 1,  "title": "string",  "type": "string"
}