/BitRail/Statistics GET
Allows BitRail to call Gunbroker to get a count of FreedomCoin Users and a count of active Items/Listings accepting FreedomCoin by State
- URL
- /BitRail/Statistics
- Verb
- Get
Header |
Data Type |
Valid Values |
Required |
Description |
Content-Type |
string |
application/json |
YES |
The format your data will be sent to our site. |
X-DevKey |
string |
string |
YES |
The devkey assigned to the developer. |
X-AccessToken |
string |
string |
YES |
The token acquired from a POST to Users/AccessToken. |
Input
NOTE: Variables to place in the query string of the request.
None
Output
If there are no errors with the input parameters, this call will respond with a 200 OK
and the following data as serialized JSON
Parameter |
Data Type |
Valid Values |
Description |
ItemCount |
number |
>= 0 |
Number of Items for sale in GB that accept FreedomCoin |
ItemsByState |
Array of ItemsByState objects (see definition below) |
|
Number of Items for sale in GB grouped by Sellers State |
ListingCount |
number |
>= 0 |
Number of Listings in GB that accept FreedomCoin |
SellerCount |
number |
>= 0 |
Number of GB users configured to use FreedomCoin. |
SellersByState |
Array of SellersByState objects (see definition below) |
|
Number of Sellers configured to use FreedomCoin in GB grouped by Sellers State |
ItemsByState Object Definition
Parameter |
Data Type |
Valid Values |
Description |
ItemCount |
number |
>= 0 |
Number of items being sold in the state |
ListingCount |
number |
>= 0 |
Number of listings in the state |
State |
string |
2 character state code |
Sellers State |
SellersByState Object Definition
Parameter |
Data Type |
Valid Values |
Description |
SellerCount |
number |
>= 0 |
Number of sellers in the state |
State |
string |
2 character state code |
Sellers State |