API REFERENCE GUIDE

Utilities  stat_api

api description

purpose

stat_api returns a associative array which contains the number of API calls done using the application key per latest periods: Day, week, month, quarter, year.

PLEASE NOTE: stat_api requires the application secret related to the application key.

http method: POST

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"stat_api"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
secret E.g. "1234567890123nonworkingexample0123456789". It must be the application secret related to the application key above. See AuverCloud Studio.

optional parameters(s)

parameter values / comments
apidE.g. "content_pub", to get information for a specific API. By default, the returned data are about all the API that have been called using the key.

call sample

This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


								

As this API method is GET, the following URL produces a similar response:

errors

code message comments
670 Wrong application secret. The parameter secret has not its expected value.
671 Unknown API ID. The optional parameter apid is unknown.

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
stat_api
key
secret
apid
 send
request
 clear
response
Response
code
msg
data

discussion