yonivy / facebook-insight-stream

Readable stream built over node-streams, provide stream api to read facebook insights

facebook-insight-stream

FacebookInsightStream provides stream API, built over node-readable-stream, to read facebook insights using the facebook Graph API V2.10. Currently facebook insights api return data per metric, this module joins all the list to one list by the insight date.

Currently support the following insights:

• pages-insights
• app-insights
• audience-network

Usage

var FacebookInsightStream = require( "facebook-insight-stream" );

var options = {
    pastdays: "30",
    node: "page" OR "post" OR "app",
    token: "Replace with your facebook access token",
    period: "day",
    metrics: ["page_views"],
    itemList: 'See comment below'
}

var pageStream = new FacebookInsightStream( options )
    //  return list of insights  e.g [ { name: "mypage", views: "10" } ]
    .on( "data", console.log )
    // "oAuth error"
    .on( "error", console.log )
    // progress status  { total: "2", loaded: "1", message: "{{remaining}} pages remain"  }
    .on( "progress", console.log )

Item list

The itemList parameter can have be passed in two forms:

1. An array of page ids. Eg: ["PAGE_ID1", "PAGE_ID2", "PAGE_ID3"]. This can be used when fetching nodes of type post or app.
2. An array of page objects including id and page access_tokens. Eg: [{id: "PAGE_ID1", token: "ABC"}, {id: "PAGE_ID2", token: "DEF"}] When an access_token is passed with each object - it is used for the requests instead of the top level user token. This can be used when fetching nodes of type page.

FacebookInsightStream options:

• pastdays (string)#number of collected days from today e.g "30", disregard to fetch beginning of time
• node (string-required)#type of insight one of the two ( "app", "page" )
• token (string-required)#valid facebook oAuth token with 'read_insigt' scope
• period (string-required)#the time period to collect according to the relevant api
• metrics (array-required)#list of metrics to collect e.g [ "page_views", "unique_users" ]
• itemList (array-required)#list of pages/apps ids to collect from
• events (array)#list of events to collect from
• aggregate (bool)#value to set if it should aggregate by relevant types
• breakdowns (array)#list of breakdowns values to break results