معرفی شرکت ها
keen.io-0.1.5
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Keen IO NodeJS module. Keen IO is a hosted API to collect, analyze, and visualize your data.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | keen.io-0.1.5 |
| نام | keen.io |
| نسخه کتابخانه | 0.1.5 |
| نگهدارنده | ['dariusz.lacheta', 'artur.pryka', 'aleksanderpapiez'] |
| ایمیل نگهدارنده | ['dariusz.lacheta@keen.io', 'artur.pryka@keen.io', 'olek@keen.io'] |
| نویسنده | Ben Pearson |
| ایمیل نویسنده | ben@inlight.com.au |
| آدرس صفحه اصلی | git://github.com/keenlabs/KeenClient-Node.git |
| آدرس اینترنتی | https://github.com/keenlabs/KeenClient-Node |
| مجوز | - |
### Deprecation notice!
We have consolidated our JS-powers with the release of [keen-js](https://github.com/keen/keen-js). All functionality from this project has been moved over, along with a bunch of new goodies.
Install keen-js
```ssh
$ npm install keen-js
```
Minor changes in client instantiation:
```javascript
// change this...
var client = Keen.configure({});
// ...into this
var client = new Keen({});
```
Scoped key en/decryption has also moved, but is documented [here](https://github.com/keen/keen-js/blob/master/docs/scoped-keys.md).
This repo will remain active for documentation purposes, but all issues, feature requests, general questions, thoughts, concerns, hopes and dreams should all happen within the keen-js project going forward.
* * *
*_Documentation below is for the original (now deprecated) KeenClient-Node SDK_*
# Keen IO - NodeJS
[](https://travis-ci.org/keenlabs/KeenClient-Node)
Keen IO is an online service to collect, analyze, and visualize your data.
## Getting Started
Use npm to install!
```javascript
npm install keen.io
```
## Examples
### Initialization
```javascript
var Keen = require('keen.io');
// Configure instance. Only projectId and writeKey are required to send data.
var client = Keen.configure({
projectId: "<project_id>",
writeKey: "<write_key>",
readKey: "<read_key>",
masterKey: "<master_key>"
});
```
You can also have multiple instances if you are connecting to multiple KeenIO accounts in the one project (probably edge case).
```javascript
var Keen = require('keen.io');
// Configure instance with API Key
var client1 = Keen.configure({...});
var client2 = Keen.configure({...});
```
In the future there will be the ability to pass options into the initialisation such as batching inserts, etc. The structure of this hasn't been defined yet but will look something like the following.
```javascript
var Keen = require('keen.io');
// Configure instance with API Key and options
var client = Keen.configure({
projectId: "<project_id>",
batchEventInserts: 30
});
```
### Send Events
```javascript
var Keen = require("keen.io");
var client = Keen.configure({
projectId: "<project_id>",
writeKey: "<write_key>"
});
// send single event to Keen IO
client.addEvent("my event collection", {"property name": "property value"}, function(err, res) {
if (err) {
console.log("Oh no, an error!");
} else {
console.log("Hooray, it worked!");
}
});
// send multiple events to Keen IO
client.addEvents({
"my first event collection": [{"property name": "property value"}, ...],
"my second event collection": [{"property name2": "property value 2"}]
}, function(err, res) {
if (err) {
console.log("Oh no, an error!");
} else {
console.log("Hooray, it worked!");
}
});
```
### Generate Scoped Key
```javascript
var Keen = require("keen.io");
var apiKey = "YOUR_API_KEY";
var scopedKey = Keen.encryptScopedKey(apiKey, {
"allowed_operations": ["read"],
"filters": [{
"property_name": "account.id",
"operator": "eq",
"property_value": "123"
}]
});
var client = Keen.configure({
projectId: "<project_id>";
readKey: scopedKey
});
```
## Queries
Analyses are first-class citizens, complete with parameter getters and setters.
The `<Client>.run` method is available on each configured client instance to run one or many analyses on a given project. Read more about running multiple analyses below.
**Format:**
```javascript
var your_analysis = new Keen.Query(analysisType, params);
```
### Example Usage
```javascript
var Keen = require('keen.io');
var client = Keen.configure({
projectId: "your_project_id",
readKey: "your_read_key"
});
var count = new Keen.Query("count", {
event_collection: "pageviews",
group_by: "property",
timeframe: "this_7_days"
});
// Send query
client.run(count, function(err, response){
if (err) return console.log(err);
// response.result
});
```
### Query Analysis Types
All of the following analyses require an `event_collection` parameter. Some analyses have additional requirements, which are noted below.
`count`
`count_unique`
`sum` requires a `target_property` parameter, where value is an integer
`average` requires a `target_property` parameter, where value is an integer
`maximum` requires a `target_property` parameter, where value is an integer
`minimum` requires a `target_property` parameter, where value is an integer
`select_unique` requires a `target_property` parameter
`extraction`
**A note about extractions:** supply an optional `email` attribute to be notified when your extraction is ready for download. If email is not specified, your extraction will be processed synchronously and your data will be returned as JSON.
`Keen.Funnel` requires a `steps` attribute
**A note about funnels:** funnels require a `steps` as an array of objects. Each step requires an `event_collection` and `actor_property` parameter.
```javascript
var funfunfunnel = new Keen.Query('funnel', {
steps: [
{
event_collection: "view_landing_page",
actor_property: "user.id"
},
{
event_collection: "signed_up",
actor_property: "user.id"
},
],
timeframe: "this_6_months"
});
```
Learn more about funnels in the [API reference](https://keen.io/docs/data-analysis/funnels/#steps)
### Run multiple analyses at once
The `<Client>.run` method accepts an individual analysis or array of analyses. In the latter scenario, the callback is fired once all requests have completed without error. Query results are then returned in a correctly sequenced array.
Query results are also attached to the query object itself, and can be referenced as `this.data`.
```javascript
var avg_revenue = new Keen.Query("average", {
event_collection: "purchase",
target_property: "price",
group_by: "geo.country"
});
var max_revenue = new Keen.Query("maximum", {
event_collection: "purchase",
target_property: "price",
group_by: "geo.country"
});
var mashup = client.run([avg_revenue, max_revenue], function(err, res){
if (err) return console.log(err);
// res[0].result or this.data[0] (avg_revenue)
// res[1].result or this.data[1] (max_revenue)
});
```
### Get/Set Parameters and Refresh Queries
```javascript
// Based on previous example
// Update parameters
avg_revenue.set({ timeframe: "this_21_days" });
max_revenue.set({ timeframe: "this_21_days" });
// Re-run the query
mashup.refresh();
```
## Future Updates
Future module updates are planned to introduce the remaining API calls. You can see some sketches for these in the [examples directory](https://github.com/keenlabs/KeenClient-Node/blob/master/examples/). Also, as mentioned above, specifying options when creating an instance to configure the behaviour of the instance (ie, batching event submissions).
## Contributing
This is an open source project and we love involvement from the community! Hit us up with pull requests and issues.
The aim is to build up this module to completely represent the API provided by Keen IO, which is quite extensive. The more contributions the better!
## Further Reading
[Keen IO - Website](https://keen.io/)
[Keen IO - API Technical Reference](https://keen.io/docs/api/reference/)
## Release History
### 0.0.4
- Update dependencies.
### 0.0.3
- Support generating Scoped Keys.
### 0.0.2
- Change error for blank write key.
### 0.0.1
- Add write/read keys.
- Reworked interface - not backwards compatible with 0.0.0!
### 0.0.0
- First release.
## License
Licensed under the MIT license.
نیازمندی
| مقدار | نام |
|---|---|
| ~0.21.0 | superagent |
| ~1.5.2 | underscore |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| 8.1.4 | Npm |
نحوه نصب
نصب پکیج tgz keen.io-0.1.5:
npm install keen.io-0.1.5.tgz