for more information on Mashape Analytics, please visit apianalytics.com
The Mashape jQuery Analytics agent reports API traffic passing through jQuery ajax calls. Works in all browsers where jQuery is supported and Node.js
1.7+
Download the latest release
$ git clone https://github.com/mashape/analytics-agent-jquery.git
$ bower install jquery-analytics
$ npm install jquery-analytics
spm install jquery-analytics
analytics-agent-jquery/
└── js/
├── jquery.analytics.js
└── jquery.analytics.min.js
Include Mashape Analytics Agent
after jQuery
.
// Basic usage
$.Analytics('SERVICE_TOKEN')
// Advanced usage
$.Analytics('SERVICE_TOKEN', {
... options ...
})
Done. Now every global
ajax request will be logged in Mashape Analytics.
Option | Description | Required | Default |
---|---|---|---|
serviceToken |
Mashape Analytics service token, required when token is not first argument. | Required | - |
environment |
Analytics environment data is stored under | Optional | - |
analyticsHost |
Mashape Analytics hostname, | Optional | socket.analytics.mashape.com |
httpVersion |
HTTP Version | Optional | HTTP/1.1 |
fallbackIp |
Fallback IP for Client / Server when not fetched | Optional | 127.0.0.1 |
hostname |
Server hostname | Optional | window.location.hostname |
fetchServerIp |
Flag to disable fetching server A Record | Optional | true |
fetchClientIp |
Flag to disable fetching client address | Optional | true |
debug |
Debug mode | Optional | false |
ssl |
Flag to enable SSL support | Optional | false |
To disable analytics logging for specific requests when making an ajax request
via jQuery set global
option to false
.
Copyright Mashape Inc, 2015.
Licensed under the MIT License