@datafire/peel_ci

Client library for Peel Tune-in API

Installation and Usage

npm install --save @datafire/peel_ci

let peel_ci = require('@datafire/peel_ci').create();

.then(data => {
  console.log(data);
});

Description

The machine learning service APIs utilize hashtags from Twitter to find related, trending shows, related Twitter hashtags in real time and to generate direct tune-in URLs.

Actions

getRelatedHashtags

Returns any official hashtag and any hashtags which were learned within the most recent time window for the show.

peel_ci.getRelatedHashtags({
  "showID": ""
}, context)

Input

• input object
  • showID required string: Unique ID for a show
  • timeWindow string: Time window in seconds (default is 2 hours)

Output

Output schema unknown

getTrendingShows

Gets trending shows.

peel_ci.getTrendingShows({}, context)

Input

• input object
  • limit string: Number of trending shows (default is 20)
  • timeWindow string: Time window in seconds (default is 2 hours)

Output

Output schema unknown

getTuneinLinks

Either use tweet, hashtags, or showID as the parameter. The tunein URLs that match best are returned in order of best match.

A tweet in this context is shorthand for text from a social networking conversation, e.g., it could be from Facebook, Twitter, LinkedIn, etc., and be greater than 140 characters.

peel_ci.getTuneinLinks({}, context)

Input

• input object
  • tweet string: Text from a social networking conversation
  • hashtags string: Comma separated list of hashtags and @mentions
  • showID string: Unique ID for a show

Output

Output schema unknown

getHealth

Get health of Tune-in service (which includes its uptime).

peel_ci.getHealth(null, context)

Input

This action has no parameters

Output

Output schema unknown

getStatuses

For Twitter, statuses are synonymous with tweets.

peel_ci.getStatuses({
  "showID": ""
}, context)

Input

• input object
  • showID required string: Unique ID for a show

Output

Output schema unknown

Definitions

This integration has no definitions