EKM Push Summary API
Posted: Mon May 18, 2015 5:24 pm
If you're interested in a long term data set that is available to all EKM Push users then this may interest you. We've been keeping this under wraps until now but we feel that it would be best to release in beta, so that we can get an idea of user and developer interest. Our Push Summary system exists in parallel with our real-time Push data system. This is how encompass.io gets its historical data for the Info, Calendar and Comparison widgets. We're happy to have you as beta testers but we reserve the right to restrict access to this API in the future. We feel that this is much more than we have been providing for free to our customers, so we are trying to determine how much or if to charge for it.
The system works by taking the real-time data and summarizing it into 15 minute chunks, which are available as is or are assembled into hour, day, or monthly summaries. Below are a bunch of example API calls that highlight the different options available. These can often times be combined to give you the exact format, data point, time frame, timezone, etc. We don't have much documentation on this system at this point so you will have to be creative about how you can combine different API call elements.
These calls use our public EKM Push Key and Meter numbers. Swap in your own to call your personal data instead.
15 minute:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json
hour:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=hr&format=json
day:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=dy&format=json
week:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=wk&format=json
month:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=mo&format=json
range (today’s date to same date last month by default):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=range&format=json
variable date range (in this case: January 4th at 8:20pm to February 8th at 8:20pm):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=range&format=html&timezone=America/Denver&start_date=2015-01-04%2020:15&end_date=2015-02-08%2020:15
month to Month day offset (5 days in this case):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=mo5&format=json&limit=4
xml:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=xml
html:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=html
csv:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=csv
multiple meters:
http://summary.ekmpush.com/summary?meters=10068,10054&key=MTAxMDoyMDIw&report=15&format=json
specific fields:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&fields=kWh_Tot_Last,kWh_Tot_Diff,kWh_Tot_Min,kWh_Tot_Max&format=json&report=15
timezone adjusted (http://en.wikipedia.org/wiki/List_of_tz_database_time_zones):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&timezone=America/Los_Angeles
specific start date/time:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&start_date=2014-11-18%2020:15
specific end date/time:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&end_date=2014-11-18%2020:15
limit number of records (will default to a limited number of records unless explicitly set):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&limit=2
offset:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=dy&format=json&offset=3
specific host:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&offset=0&limit=10&host=col.c1.ekmmetering.com
*Note: the number of records returned will default to a limited number. If you want more records than the default, then add the &limit=**** number and set it o the number of records that you want returned.
The system works by taking the real-time data and summarizing it into 15 minute chunks, which are available as is or are assembled into hour, day, or monthly summaries. Below are a bunch of example API calls that highlight the different options available. These can often times be combined to give you the exact format, data point, time frame, timezone, etc. We don't have much documentation on this system at this point so you will have to be creative about how you can combine different API call elements.
These calls use our public EKM Push Key and Meter numbers. Swap in your own to call your personal data instead.
15 minute:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json
hour:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=hr&format=json
day:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=dy&format=json
week:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=wk&format=json
month:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=mo&format=json
range (today’s date to same date last month by default):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=range&format=json
variable date range (in this case: January 4th at 8:20pm to February 8th at 8:20pm):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=range&format=html&timezone=America/Denver&start_date=2015-01-04%2020:15&end_date=2015-02-08%2020:15
month to Month day offset (5 days in this case):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=mo5&format=json&limit=4
xml:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=xml
html:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=html
csv:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=csv
multiple meters:
http://summary.ekmpush.com/summary?meters=10068,10054&key=MTAxMDoyMDIw&report=15&format=json
specific fields:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&fields=kWh_Tot_Last,kWh_Tot_Diff,kWh_Tot_Min,kWh_Tot_Max&format=json&report=15
timezone adjusted (http://en.wikipedia.org/wiki/List_of_tz_database_time_zones):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&timezone=America/Los_Angeles
specific start date/time:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&start_date=2014-11-18%2020:15
specific end date/time:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&end_date=2014-11-18%2020:15
limit number of records (will default to a limited number of records unless explicitly set):
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&limit=2
offset:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=dy&format=json&offset=3
specific host:
http://summary.ekmpush.com/summary?meters=10068&key=MTAxMDoyMDIw&report=15&format=json&offset=0&limit=10&host=col.c1.ekmmetering.com
*Note: the number of records returned will default to a limited number. If you want more records than the default, then add the &limit=**** number and set it o the number of records that you want returned.