LUluminatedata
Charts

Chart Data

Receive metadata and ranking data for a Chart using a Luminate ID.

get/charts/{id}

Request

  • Base URL
    https://api.luminatedata.com
  • URL
    https://api.luminatedata.com/charts/{id}
  • Auth
    API key in header x-api-key and API key in header authorization

Path parameters

idstring required

Unique Luminate ID assigned to the Chart.

Query parameters

chart_weekstring

Represents the 7-day period (Fri-Thur) used in the aggregation of consumption data. Value must be formatted according to the ISO 8601 week standard (YYYY-Www).

Response

Successfully retrieved chart data

idstring
chart_namestring
chart_ownerstring
entity_typestring
descriptionstring
locationstring
depthinteger
earliest_chart_weekstring
chart_metricsstring[]
chart_weekstring
start_datestring
end_datestring

Changes

No recorded changes to this operation across all 1 revision of this API.