Stats


Stats Object

Description

Customer and contract statistics.

Fields

Field Type Optional Description
active_customers Number No The approximate number of currently active customers (customers that have accessed the system in the last hour).
contracts_last_month Number No The number of contracts executed last month.
contracts_this_month Number No The number of contracts executed so far this month.
contracts_today Number No The number of contracts executed so far today.
total_customers Number No The total number of customers.

JSON Sample

[ {
  "active_customers" : 30,
  "contracts_last_month" : 64823,
  "contracts_this_month" : 23022,
  "contracts_today" : 4474,
  "total_customers" : 112
} ]

GET stats

Description

Get customer and contract statistics (active customers, total customers, contracts today, contracts last month, contracts this month)

Resource URL

https://api.optionscity.com/stats
Authentication Required
HTTP Methods GET
Media Types application/json
Response Object Stats
Response Type Standard

Example Request

GET https://api.optionscity.com/stats

Example Response

[ {
  "active_customers" : 30,
  "contracts_last_month" : 64823,
  "contracts_this_month" : 23022,
  "contracts_today" : 4474,
  "total_customers" : 112
} ]

* Date and time elements are ISO-8601 string representations