GET /api/v202606/edx/schema

Returns the catalog of tables and columns available to query.

GetSchemaV202606
Use this endpoint to discover the EDX tables and columns available before validating or executing a query. The schema browser and editor use this same catalog. Each column reports a logical data-type category (string, int, double, decimal, currency, billingperiod, bool, or datetime). Currency and billing-period columns compute as decimal and int respectively in KQL, so calculations and comparisons are unaffected; the narrower type only tells clients how to format and label the value. Related fields identify unit codes and display names needed to format a value. This is also where optional presentation metadata identifies entity-link columns and the entity type addressed by each link. Requires the WattsReporting 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.

Responses

200 The table/column catalog. The request succeeded and the response body contains the requested data.

Response Body Parameters

EdxSchemaV202606
Property Description Type
tables EdxSchemaTableV202606[]
EdxSchemaTableV202606 properties
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
description Human-readable description of what the table represents, when documented. string
name string
Example Response application/json 
{  "tables": [
    {    "columns": [
      {      "dataType": "string",      "description": "string",      "name": "string",      "presentation": {},      "relatedFields": []
    }
    ],    "description": "string",    "name": "string"
  }
  ]
}