Difference between revisions of "M4 API quickstats get"
From Kolmisoft Wiki
Jump to navigationJump to search
m (Admin moved page M2 API quickstats get to M4 API quickstats get) |
|||
| Line 4: | Line 4: | ||
Data can be retrieved for the '''System Admin''', '''Manager''' and a '''Simple User'''.<br> | Data can be retrieved for the '''System Admin''', '''Manager''' and a '''Simple User'''.<br> | ||
'''Note''' | '''Note''' Managers can retrieve data only if have permission to manage DASHBOARD> Quick Stats | ||
<br><br> | <br><br> | ||
'''Simpe User Notes:''' | '''Simpe User Notes:''' | ||
* Active Calls can be retrieved for Simple Users only if a Setting: '''MAINTENANCE > Settings > Show Active Calls for Users''' is on. | * Active Calls can be retrieved for Simple Users only if a Setting: '''MAINTENANCE > Settings > Show Active Calls for Users''' is on. | ||
* Simple users can only see the | * Simple users can only see the number of Calls, Call Duration, Call Price, and Balance. | ||
<br> | <br> | ||
=Usage= | =Usage= | ||
* ''' | * '''M4''' call: '''/api/quickstats_get''' | ||
* Methods: POST, GET(if allowed, not | * Methods: POST, GET(if allowed, not recommended) | ||
<br><br> | <br><br> | ||
===Parameters=== | ===Parameters=== | ||
| Line 21: | Line 21: | ||
* u - username for authentication. '''Required'''. | * u - username for authentication. '''Required'''. | ||
'''Note that u is included in | '''Note that u is included in the HASH only if u is not the System Admin''' | ||
<br><br> | <br><br> | ||
| Line 83: | Line 83: | ||
=See also= | =See also= | ||
* [[ | * [[M4 API]] | ||
Latest revision as of 11:12, 28 November 2022
Description
Retrieves Quick Stats and Active Calls for today and a current month
Data can be retrieved for the System Admin, Manager and a Simple User.
Note Managers can retrieve data only if have permission to manage DASHBOARD> Quick Stats
Simpe User Notes:
- Active Calls can be retrieved for Simple Users only if a Setting: MAINTENANCE > Settings > Show Active Calls for Users is on.
- Simple users can only see the number of Calls, Call Duration, Call Price, and Balance.
Usage
- M4 call: /api/quickstats_get
- Methods: POST, GET(if allowed, not recommended)
Parameters
- hash - SHA1 hash constructed using API_Secret_Key ( More described in Constructing hash). Required (if setting Disable hash checking is not checked).
- u - username for authentication. Required.
Note that u is included in the HASH only if u is not the System Admin
Request
If API Secret Key = secret
You send:
HTML POST: http://<SERVER_IP>/billing/api/quickstats_get?u=admin&hash=e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4
* Note that username (u) is not included in the hash
Returns
Success: Everything is ok. You get the list of calls if there is any:
<?xml version="1.0" encoding="UTF-8"?>
<page>
<quickstats>
<today>
<calls>4</calls>
<duration>345</duration>
<revenue>1.4475</revenue>
<self_cost>0.6725</self_cost>
<profit>0.775</profit>
<margin>54</margin>
</today>
<month>
<calls>19</calls>
<duration>2182</duration>
<revenue>6.04</revenue>
<self_cost>3.734166</self_cost>
<profit>2.305834</profit>
<margin>38</margin>
</month>
<active_calls>
<total>0</total>
<answered_calls>0</answered_calls>
</active_calls>
</quickstats>
</page>
Errors:
- <error>API Requests are disabled</error> – Allow API globally setting is unchecked
- <error>GET Requests are disabled</error> – Allow GET API setting is unchecked
- <error>Access Denied</error> – user with such username cannot use this method
- <error>Bad login</error> – such username does not exist in the database or it was not specified
- <error>Incorrect hash</error> – Hash was not correct. Check API_Secret_Key and order or params while concatenating hash_string
- <error>Cannot connect to Elasticsearch</error> – data is not reachable
Example:
<status> <error>API Requests are disabled</error> </status>
