npm

Need private packages and team management tools?Check out npm Orgs. »

jquery-analytics

1.3.1 • Public • Published

Mashape jQuery Analytics Agent

Bower version npm version License Build Status devDependency Status

The Mashape jQuery Analytics agent reports API traffic passing through jQuery ajax calls. Works in all browsers where jQuery is supported and Node.js

Quick start

  • Download the latest release.
  • Clone the repo: git clone https://github.com/mashape/analytics-agent-jquery.git.
  • Install with Bower: bower install jquery-analytics.
  • Install with npm: npm install jquery-analytics.
  • Install with SPM: spm install jquery-analytics.

Requirements

  • jQuery 1.7+
  • Mashape Analytics Service Token SERVICE_TOKEN

What's included

analytics-agent-jquery/
└── js/
    ├── jquery.analytics.js
    └── jquery.analytics.min.js

Usage

Include Mashape jQuery Analytics after jQuery.

// Basic usage
$.Analytics('SERVICE_TOKEN')
 
// Advanced usage
$.Analytics('SERVICE_TOKEN', {
  ... options ...
})

Done. Now every global ajax request will be logged in API Analytics.

Options

  • environment - Required Analytics environment data is stored under, defaults to user default environment.
  • serviceToken - Optional Mashape Analytics service token, required when token is not first argument.
  • analyticsHost - Mashape Analytics hostname, defaults to socket.analytics.mashape.com/
  • httpVersion - HTTP Version, defaults to HTTP/1.1
  • fallbackIp - Fallback IP for Client / Server when not fetched, defaults to 127.0.0.1
  • hostname - Server hostname, defaults to window.location.hostname
  • fetchServerIp - Flag to disable fetching server A Record, defaults to true
  • fetchClientIp - Flag to disable fetching client address, defaults to true
  • debug - Debug mode
  • ssl - Flag to enable SSL support, defaults to false

Disable analytics for request

To disable analytics logging for specific requests when making an ajax request via jQuery set global option to false.

Copyright and license

Copyright Mashape Inc, 2015.

Licensed under the MIT License.

install

npm i jquery-analytics

Downloadsweekly downloads

2

version

1.3.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability