You are on page 1of 8

Non-Technical API Documentation

Updated: May 26, 2011 Version 1.3

Table of Contents
I. Introduction to the PeopleBrowsr API3 II. Non-Technical Documentation3 III. Name Option Parameters.4
1. Section 1.........4
@Name Cloud

2. Section 2.....5
Word Cloud Hash Tag Cloud Top URLs Top Videos Top Pictures

3. Section 3.........6
Top Countries Top US Areas Mentions Sentiment Top Influencers Positive Influencers Negative Influencers Friends and Followers Density Popularity Mentions and Re-Tweets

4. Summary.....7

IV. About PeopleBrowsr.8

I. Introduction to the PeopleBrowsr API


The PeopleBrowsr API allows companies to develop their own programs using our rich Datamine. At PeopleBrowsr, we store over 3 terabytes of data per month, at the rate of 10,000 posts per second. We were one of the first companies to obtain access to the Twitter Full Firehose and weve been storing, retrieving and indexing data for almost 4 years. Developers may use the PeopleBrowsr API to tap into our social media analytics Datamine through a wide assortment of chart types. This non-technical guideline introduces the PeopleBrowsr API and explains our capabilities in the simplest form.

II. Non-Technical Documentation


PeopleBrowsr uses the OAuth standard for API authentication. All calls through the API must include the following parameters: Date Range, Source (Twitter, Facebook, MySpace, blogs or forums), Term (the search query) and Name options. The number of allowed calls per day depends on the level of access granted with your pricing plan. You are free to utilize the API in whichever way you want, including nesting or looping calls. Heres an example of the required parameters for an API call: Date Range: 2011-04-01 to 2011-05-01 Source: Twitter, Facebook, Myspace Term: Pepsi+State:NY Name: Word Cloud This will return a list of the most frequently occurring words appearing with Pepsi in the state of New York across Twitter, Facebook and MySpace from April 01, 2011 to May 1, 2011. If you want to also see the most frequently used #hashtags associated with the term Pepsi in New York, this would be a separate call, as the Hash Tag Cloud is a separate Name option. The Name parameters provide the necessary data to visually represent insights. Whether youre interested in the most popular keywords associated with your search query (Word Count), the most popular websites mentioned with your brand (Top URLs) or whos talking about your brand the most (Influencers), each Name option returns a specific data set correlating to the desired chart type.

III. Name Option Parameters


There are three sections for Name options named Section 1, Section 2, and Section 3. The sources for these Name options include Twitter, Facebook, MySpace, and blogs, unless otherwise noted. Every call must also include Date Range and the Term (search query). The amount of data returned for each call depends on the search query.

1. Section 1
Through using Name option @NameCloud, we can help you find users (@names) using a variety of different methods. Indexing social commentary to identify a mentioned keyword(s) (car), related words to that keyword, words near that keyword (find messages with red within 10 words from car), and words preferably near that keyword(s) in a given time period was where we began. We also can return users by gender, bio (psychographic profile), sentiment, and location. With our search you can combine term functionality to return exactly what youre looking to find. For more information and for examples, please see the term detail section in the Technical API Documentation. @ Name Cloud: The most frequently occurring @names appearing with a term. This data can be used for insights into whos talking about your keywords the most, helping you to identify your top influencers for instant engagement and follower build.

2. Section 2
These Name options provide data sets with frequency analysis to identify patterns and trends. Social Sphere refers to how items are related to a term within the content. Determine popularity and discover how often your brand is mentioned with other terms. Word Cloud: The most frequently occurring words appearing with a term. For example, searching for Coca-Cola may return drink, Fanta and Pepsi as the most popular keywords mentioned with the brand. Hash Tag Cloud: The most frequently occurring hashtags appearing with a term. This data can be used to visualize popular hashtags related to your keywords. For example, searching for #coca-cola may return #cocacola, #giveaway and #win with the brand name mention. Top URLs: The most frequently occurring URLs. This data helps you to determine the most popular links related to a term. Gain a better understanding of your customers through analyzing the websites they share, from news content or promotion pages to user generated sites, such as YouTube. Top Videos: The most popular YouTube links appearing with a term. This data can be especially helpful for determining the viral success of your video campaign. In addition, gain insights into the type of content your customers are sharing, from top trending videos to TV advertisements and customer reviews. All video links are YouTube URLs, shortened in the "youtu.be" format. Top Pictures: The most popular TwitPic links appearing with a term. This data can be used to determine the type of photos your customers are sharing, from print ads to slice-of-life moments. Use this data to view the content your users are generating and gain a better understanding into their personas. All photo URLs are TwitPic.com links.

3. Section 3
These Name options provide data sets related to perception and community interaction. Social presence refers to demographics and psychographics, message distribution, popularity, influence and follower relations. Top Countries: The top country codes associated with a term, generated in a list ranked by volume. Understand where your brand is being mentioned the most, from the United States to Japan to Brazil. See Appendix A in the Technical API Documentation for a full listing. Top US Areas: The top US states associated with a term. All states are abbreviated by US state codes, generated in a list ranked by volume. Gain insights into geographical areas where your brand is more popular on social networks, perhaps correlating to a regional launch or urban popularity for certain brands. See Appendix B in the Technical API Documentation for a full listing. Mentions: A day-by-day chart listing the number of times a term has been mentioned. Easily track changes in volume and spot spikes in mentions over time. Sentiment: A list categorizing negative, neutral and positive sentiment to the number of posts for each day. Analyze public opinion, brand buzz and overall perception over time. Top Influencers: A list of the top users mentioning the term, ranked by the number of followers. A persons influence is determined by having the most followers who are talking about a specific keyword. Positive Influencers: A list of top users mentioning the term in at least one positive post. A persons influence is determined by having the most followers who are talking about a specific keyword. Negative Influencers: This option returns a list of the top users mentioning the term in at least negative post. A persons influence is determined by having the most followers who are talking about a specific keyword. Friends and Followers: A list of followers and following counts, arranged by date. Counts are retrieved only from posts that the user has made during the date range specified. If there are no posts on a given day/timepoint in the range, the counts from the previous day will be retrieved. Density: A daily list of posts and unique posters (voices). Gain insights into how many of your posts are coming from the same people. Popularity: The sources for popularity only include Twitter and Facebook. This list shows the number of ReTweets and Likes, respectively. See how well your messages are shared and received with cross network analysis. Mentions and ReTweets: This is a meta-chart that calls mentions and popularity, and remaps the two labels: Mentions is remapped as Total and Popularity is remapped as ReTweets. Analyze the number of times your term has appeared and how many times your term was shared.

4. Summary
The PeopleBrowsr API allows you to build custom social analytics applications relevant to your company needs. Datamining is one of our core strengths and we are recognized for our contribution to advancing conversation technologies. By incorporating the PeopleBrowsr API into your development, youll have the capabilities to create tailored social analytics applications with access to our deep historical database. To attain an API key, please email api@peoplebrowsr.com with your company name and a brief description of your intended use for the API. One of our representatives will get back to you with you to address pricing, setup, and how to move forward. If granted access, you will need to sign your requests using the OAuth Consumer Key and OAuth Consumer Secret we provide. For more technical information, please see our Technical API Documentation or send us an email api@peoplebrowsr.com.

IV. About PeopleBrowsr


PeopleBrowsr is a high-tech social analytics company passionate about marketing, providing social media brand engagement, data mining intelligence and sophisticated social search. The PeopleBrowsr Platform includes ReSearch.ly, Viral Analytics and the Engagement Center. Enterprise Services are also available upon request. We help our customers at global brands and Advertising/PR agencies identify and engage influencers, cultivate communities, gain in-depth insights from specialized research reporting and human sentiment analysis, and develop hyper-targeted campaigns to increase social media ROI. For more information, please email: contact@PeopleBrowsr.com