Difference between revisions of "API Metric Data List"

From unroole CMS wiki
Jump to: navigation, search
Line 1: Line 1:
 +
==URI==
 +
https://api.unroole.com/metered_data
 +
==HTTP Method==
 +
GET
 +
==Paramaters==
 +
 +
{| class="wikitable"
 +
|-
 +
! Paramater
 +
! Default
 +
! Maximum Length
 +
! Accepted Values
 +
! Description
 +
{{:API Required Parameter Common}}
 +
|-
 +
|type
 +
| storage
 +
|
 +
|  storage, bandwidth
 +
|
 +
|-
 +
| zoom
 +
| daily
 +
|
 +
|hourly, daily, weekly, monthly
 +
|
 +
|-
 +
|start_date
 +
|1 year ago
 +
|
 +
|dateformat yyyy-mm-dd
 +
|
 +
|-
 +
|end_date
 +
|current date
 +
|
 +
|dateformat yyyy-mm-dd
 +
|
 +
|}
 +
 +
Paramaters accepted by the controller:
 +
 
Json Structure:
 
Json Structure:
 
<blockquote>
 
<blockquote>

Revision as of 14:39, 27 July 2012

URI

https://api.unroole.com/metered_data

HTTP Method

GET

Paramaters

Paramater Default Maximum Length Accepted Values Description
token API Persistence Token that identifies this user and its permissions.
type storage storage, bandwidth
zoom daily hourly, daily, weekly, monthly
start_date 1 year ago dateformat yyyy-mm-dd
end_date current date dateformat yyyy-mm-dd

Paramaters accepted by the controller:

Json Structure:

[ { "name": "Line Name", "data": [ [ 'Year/Month/Day', "Value" ],... ] },... ]

Sample Json: