Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added GET REST endpoints

 

Overview

...

APIAPI ProviderMetrics gathered
ForceSalesforce.comRaw Leads, MQLs, Sales Opportunities
Youtube reporting APIYoutube.comViews, Subscribers
LinkedIn ApiLinkedIn.comFollowers
Twitter4jOpen SourceFollowers
AWS APIAmazon.comS3 product download logs
Github WebhooksGithubGithub Statistics
Pro Ranking ApiPro RankingWebsite ranking

 

Api Calls

  • Use a Workflow Custom Action to run periodic RESTful calls to  APIs
  • A spark job can read the data from filesystem and update the cube
  • In order to allow different scheduling of different calls, each call will have its own workflow

REST EndPoints

MethodEnd PointDescriptionResponse
GET/pipeline/{time period}Returns the data related to marketing and sales leads
time period E {week, month} 
Code Block
languagejs
{
start: 06-06-2016,
end: 06-07-2016,
rawleads: 180,
mlq: 60,
inquiries: 100,
opp: 20
}
GET/awareness/webtraffic/{time priod}

Returns the traffic related information for website and

blog

Code Block
languagejs
{
start: 06-06-2016,
end: 06-07-2016,
sessions: 200,
newVisitors: 68,
returningVisitors: 80
blogViewers: 100
}
GETawareness/socialmedia/subscribersReturns the subscribers on various social media sites
Code Block
languagejs
{
youtube: {
		views: 23,
		subscribers: 2900 
			},
linkedin: 68,
twitter: 80
}
GETawareness/seoReturns the share of voice numbers
Code Block
languagejs
{
cask: 25,
informatica: 25,
talend: 25,
snaplogic: 25
}

GETadoption/downloadsReturns the number of downloads for cdap
Code Block
languagejs
 {downloads: [ {version: 3.5 , dl: 2000 } ]}

 


UI

  • UI could be deployed on a thin coopr node
  • Probable stack for UI will be Jquery embedded in a bootsrap dashboard
  • ChartJS and c3JS would be used to render charts

...

  • UI should allow refining all metrics to different time granularities (Hourly, Daily, Weekly, Monthly, Every three months, Every year)

  • Visualize metrics in the form of Dashboard (Widgets - Line, Bar, Pie, Scatter, ...)

  • Dashboard and backend should support overlaying week-over-week, month-over-month or year-over-year for any metric

  • Backend should  allow for raw querying of data through SQL commands

...

  • Email and text notifications can be sent using SendGrid or Amazon SNS service

  • Users can unsubscribe or subscribe using front end backed by apis
  • Generate daily and weekly digest report and email them to stakeholders

  • Export data into PDF/Excel available for download in UI

...