RESTful API

/api/v2/logintotal

Request Type

GET

Returns the application's login count for a select range (GMT). No user identity string required.

Example URL


                            https://example.stitchz.net/api/v2/logintotal

Request

Required	Parameter	Type	Description
	Bearer	string	The application's unique Oauth2 bearer token (access token) in the request header
	Format	string	The format of the authenticated Stitchz response, XML, JSON, JSONP. A query string parameter can be included in the request (e.g. ?format=json) or a header variable of "Accept" with the proper value, e.g. 'application/json', 'application/xml', etc. The default response is in "JSON" format.

Example Request

$ curl -H "Authorization: Bearer e72e16c7e42f292c6912e7710c838347ae178b4a"
-H "Accept: application/json"
-A "example client"
https://example.stitchz.net/api/v2/logintotal

GET /api/v2/logintotal HTTP/1.1
User-Agent: example client
Host: example.stitchz.net
Accept: application/json
Authorization: Bearer e72e16c7e42f292c6912e7710c838347ae178b4a

Response

Field	Type	Description
ApiKey	string	The unique Application key. This is an automatically assigned number that identifies the application.
CurrentMonthTotalLoginAttempts	number	Total number of login attempts in the current month.
CurrentMonthTotalUniqueLogins	number	Total number of unique logins in the current month.
MonthlyLoginLimit	number	Maximum allowed logins in one month period. Limit is determined by the application type, i.e. basic, professional, enterprise
TotalLoginAttempts	number	Total login attempts during the lifetime of the application
TotalSuccessfulLogins	number	Total successful logins during the lifetime of the application

* all fields are always returned in the response.

Example XML Response

Example JSON Response


                                <logintotal>

                                    <apikey>000000000000</apikey>

                                    <currentmonthtotalloginattempts>105</currentmonthtotalloginattempts>

                                    <currentmonthtotaluniquelogins>108</currentmonthtotaluniquelogins>

                                    <monthlyloginlimit>200</monthlyloginlimit>

                                    <totalloginattempts>785</totalloginattempts>

                                    <totalsuccessfullogins>745</totalsuccessfullogins>

                                </logintotal>


                                {

                                    "ApiKey":000000000000,

                                    "CurrentMonthTotalUniqueLogins":105,

                                    "CurrentMonthTotalLoginAttempts":108,

                                    "MonthlyLoginLimit":200,

                                    "TotalLoginAttempts":785,

                                    "TotalSuccessfulLogins":745

                                }