flurry-api - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

lib/metric.js

@@ -35,3 +35,3 @@ var request = require('request'),
 Metric.prototype.groupBy = function(group){
-  this.params['groupBy'] = group;
+  this.params.groupBy = group;
   return this;
@@ -38,0 +38,0 @@ };

lib/util.js

@@ -23,3 +23,6 @@ exports = module.exports = require('util');
 exports.formatError = function(data){
-  return new Error(data.message + ' (Code: ' + data.code + ')');
+  var err = new Error(data.message + ' (Code: ' + data.code + ')');
+  err.code = data.code;
+
+  return err;
 };

package.json

 {
   "name": "flurry-api",
-  "version": "0.0.2",
-  "description": "Flurry APi",
+  "version": "0.0.3",
+  "description": "Flurry API for Node.js",
   "main": "lib/flurry",
@@ -6,0 +6,0 @@ "scripts": {

README.md

@@ -1,1 +0,93 @@
-# Flurry API
+# Flurry API
+
+[![NPM version](https://badge.fury.io/js/flurry-api.svg)](http://badge.fury.io/js/flurry-api)
+
+Flurry API for Node.js.
+
+## Installation
+
+``` bash
+$ npm install flurry-api 
+```
+
+## Usage
+
+Create a new flurry instance:
+
+``` js
+var flurry = new Flurry({
+  apiAccess: '',
+  apiKey: ''
+});
+```
+
+## API
+
+### getApplication(callback)
+
+Returns information of an application. See [here][AppInfo] for more info.
+
+### getAllApplications(callback)
+
+Returns information of all applications. See [here][AppInfo] for more info.
+
+### appMetric(metric)
+
+Returns application metric of an application. See [here][AppMetrics] for more info.
+
+**Metrics:**
+
+- **ActiveUsers** - Total number of unique users who accessed the application per day.
+- **ActiveUsersByWeek** - Total number of unique users who accessed the application per week. Only returns data for dates which specify at least a complete calendar week.
+- **ActiveUsersByMonth** - Total number of unique users who accessed the application per month. Only returns info for dates which specify at least a complete calendar month.
+- **NewUsers** - Total number of unique users who used the application for the first time per day.
+- **MedianSessionLength** - Median length of a user session per day.
+- **AvgSessionLength** - Average length of a user session per day.
+- **Sessions** - The total number of times users accessed the application per day.
+- **RetainedUsers** - Total number of users who remain active users of the application per day.
+- **PageViews** - Total number of page views per day.
+- **AvgPageViewsPerSession** - Average page views per session for each day.
+
+### eventMetric([event])
+
+Returns event metric of an application. Leave `event` argument blank for event summary. See [here][EventMetrics] for more info.
+
+### Metric.startDate(date)
+
+Sets start date. `date` should be a date object or a string in `YYYY-MM-DD` format.
+
+**Alias:** start
+
+### Metric.endDate(date)
+
+Sets end date. `date` should be a date object or a string in `YYYY-MM-DD` format.
+
+**Alias:** end
+
+### Metric.country(country)
+
+Filters by country or use `ALL` to break down data by countries. You can find abbreviation of all countries [here](http://support.flurry.com/index.php?title=Countries).
+
+### Metric.versionName(versionName)
+
+Filters by version name.
+
+**Alias:** version
+
+### Metric.groupBy(group)
+
+Groups data into `DAYS` (default), `WEEKS` or `MONTHS`.
+
+**Alias:** group
+
+### Metric.exec(callback)
+
+Executes a query and returns data.
+
+## License
+
+MIT
+
+[AppMetrics]: http://support.flurry.com/index.php?title=API/Code
+[AppInfo]: http://support.flurry.com/index.php?title=API/Code/AppInfo
+[EventMetrics]: http://support.flurry.com/index.php?title=API/Code/EventMetrics

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

7916

increased by53.38%

Lines of code

106

increased by1.92%

Number of lines in readme file

93

increased by9200%

No dependency changes