...
...
| Table of Contents |
|---|
We have implemented simple Usage API to get instant information about your Web Service's account usage.
You can simply enter any Usage API URL into browser or use automated HTTP GET call.
Following methods are available:
Basic usage API
count
Returns count of successful calls of specified web service.
...
https://solargis.info/ws/usage/datadelivery/count?key=demo
https://solargis.info/ws/usage/pvplanner/count?key=demo
Optional parameters:
from - count WS calls beginning with specified date, inclusive; format
yyyy-MM-dd(e.g.2014-01-01)to - count WS calls until specified date, exclusive; format
yyyy-MM-dd
Full example:
https://solargis.info/ws/usage/datadelivery/count?key=demo&from=2014-01-01&to=2015-01-01 (demo calls to datadelivery WS for year 2014)
...
Returns sum of days of data returned from DataDelivery WS: request / response examples, also known as "Information Units" (data units). No matter of summarization used, number of requested days are counted.
...
https://solargis.info/ws/usage/datadelivery/units?key=demo
Optional parameters:
from - DataDelivery calls beginning with specified date, inclusive; format
yyyy-MM-dd(e.g.2014-01-01)to - DataDelivery calls until specified date, exclusive; format
yyyy-MM-ddsum - filter by DataDelivery summarization, use one of: MONTHLY, DAILY, HOURLY, MIN_15
Full example:
https://solargis.info/ws/usage/datadelivery/units?key=demo&from=2014-01-01&to=2015-01-01&sum=HOURLY (retrieved data units in HOURLY summarization by demo account during year 2014)
limit/units
Returns current Information Units (data units) for DataDelivery WS: request / response examples, which are remaining (if any) or N/A otherwise. If 0 is returned, usage limit is reached and no more calls will be processed. Processing or request is also not possible if requested number of data units is exceeding remaining Information Units (data units).
...
https://solargis.info/ws/usage/datadelivery/limit/units?key=YOUR_KEY
DataDelivery site units API
...
will return result equivalent to this table:
data_period | data_summarization | count |
|---|---|---|
HISTORIC | MIN_15 | 10 |
RECENT | HOURLY | 20 |
RECENT | MIN_15 | 150 |
FORECAST | HOURLY | 30 |
which for billing period of March 2016 summarizes how many site units of each type were consumed, e.g. 10 units for type = "HISTORIC + MIN_15", 20 units for type = "RECENT + HOURLY" etc.
...
Each dataDelivery call is associated with one or more time periods depending on the "dateFrom", "dateTo" fields of the request. There are three types of time periods recognized by dataDelivery ws:
HISTORIC = all data older than beginning of previous month
RECENT = all data between beginning of previous month (inclusive) and today (exclusive)
FORECAST = all data where "dateTo" >= today
| Info |
|---|
In case one request falls into multiple time periods, each time period is recorded on its own, therefore one request can be counted for example as RECENT access and also as a FORECAST access. |
...
For example, following three requests made during billing period of March 2016:
dateFrom=2016-02-01, dateTo=2016-02-01, summarization = MIN_15, latitude = 0, longitude = 0
dateFrom=2016-02-02, dateTo=2016-02-02, summarization = MIN_15, latitude = 0, longitude = 0
dateFrom=2016-02-01, dateTo=2016-02-29 summarization = MIN_15, latitude = 10, longitude = 10
would be counted as 2 site units of type "RECENT + MIN_15"
...
For example following requests made during billing period of March 2016:
dateFrom=2016-01-01, dateTo=2016-01-31, summarization = MIN_15, latitude = 0, longitude = 0
dateFrom=2015-12-10, dateTo=2016-01-05, summarization = MIN_15, latitude = 0, longitude = 0
would be counted as 3 site units of type "HISTORIC + MIN_15", while following requests:
dateFrom=2015-12-01, dateTo=2015-12-01, summarization = MIN_15, latitude = 0, longitude = 0
dateFrom=2015-12-31, dateTo=2015-12-31, summarization = MIN_15, latitude = 0, longitude = 0
would be counted as only one site unit of type "HISTORIC + MIN_15"
...
For example following requests made during billing period of March 2016:
dateFrom=2016-02-01, dateTo=2016-02-01, summarization = MIN_15, latitude = 0, longitude = 0
dateFrom=2016-02-15, dateTo=2016-02-15, summarization = HOURLY, latitude = 0, longitude = 0
dateFrom=2016-02-01, dateTo=2016-02-29, summarization = MIN_30, latitude = 10, longitude = 10
would be counted as following:
data_period | data_summarization | count |
|---|---|---|
RECENT | HOURLY | 1 |
RECENT | MIN_30 | 1 |
RECENT | MIN_15 | 1 |
(thus including both HOURLY and MIN_15 for site with the same latitude / longitude)
...
Basic billing period is one month. When When parameters "from" and "to" are used to specify billing periods longer than one month, first the partial results for each month will be calculated and then the partial results will be summed up for the final result.
If the specified billing period is shorter than one month, or is not a whole multiple of a month then the last partial billing period will be adjusted to length shorter than one month.
RECENT and FORECAST site units charged in previous billing period won't be charged in the next billing period. That is to assure that each month of data (of type RECENT or FORECAST) is charged only once, regardless of during which billing periods the requests were made.
For example following RECENT request made during billing period of March 2016:
dateFrom=2016-03-01, dateTo=2016-03-30, summarization = MIN_15, latitude = 0, longitude = 0
will be counted as 1 site unit, while while this RECENT request made during period of April 2016:
dateFrom=2016-03-31, dateTo=2016-03-31, summarization = MIN_15, latitude = 0, longitude = 0
will be counted as 0 site units, because this site unit was already charged during March billing period.
| Note |
|---|
Requests made during previous billing period do not affect billing of HISTORIC data. |
DataDelivery unique information units API
...
Returns number of consumed unique information units in CSV format for given billing period as well as site coordinates (latitude, longitude) with associated unique information units spent for given location. The unique information API operates in two modes:
RECENT + HISTORIC access (default) = include all web service calls where "dateTo" of requested data is < today
FORECAST access = include all web service calls where "dateTo" of requested data is >= today
To request recent + historic access report for demo account (key = demo) and for September 2019 you can use following URL. Replace key with your account key (provided to you by sales person) to know consumption of your unique information units.
...
https://solargis.info/ws/usage/datadelivery/uiu?key=demo&from=2019-09-01&to=2019-10-01&mode=FORECAST
In order to get consumption report for different billing periods just replace "from" and "to" parameters in the url.
...