public
Description: Ruby frontend to the Feedburner Awareness API
Homepage: http://rubyforge.org/projects/rawapi/
Clone URL: git://github.com/bwyrosdick/ruby-awareness-api.git
Search Repo:
name age message
folder .gitignore Thu Mar 27 21:50:54 -0700 2008 added rdoc [bwyrosdick]
folder CHANGELOG Wed Mar 05 08:44:13 -0800 2008 merged newer code into gem structure [bwyrosdick]
folder LICENSE Wed Mar 05 09:12:42 -0800 2008 prepared gem to be packaged as 0.2.1 with a gem... [bwyrosdick]
folder README Thu Mar 27 21:50:54 -0700 2008 added rdoc [bwyrosdick]
folder Rakefile Thu Mar 27 21:50:54 -0700 2008 added rdoc [bwyrosdick]
folder demo.rb Wed Mar 05 09:12:42 -0800 2008 prepared gem to be packaged as 0.2.1 with a gem... [bwyrosdick]
folder lib/ Wed Mar 05 12:20:31 -0800 2008 packaged the 0.2.1 release [bwyrosdick]
folder rawapi-0.2.1.gem Wed Mar 05 12:29:54 -0800 2008 packaged the 0.2.1 release [bwyrosdick]
folder rawapi.gemspec Wed Mar 05 12:29:54 -0800 2008 packaged the 0.2.1 release [bwyrosdick]
folder test/ Wed Mar 05 08:06:35 -0800 2008 initial pull of files from rubyforge from 0.1.2 [bwyrosdick]
README
AwAPI docs at http://code.google.com/apis/feedburner/awareness_api.html

== This Library

The Ruby Awareness API (rAwAPI) provides a ruby interface to the FeedBurner Awareness API (AwAPI)

== What is "Awareness?"

Feed Awareness describes the extent and frequency with which a publisher's feed and its content items are consumed, 
clicked on, and referred to by independent sources (i.e., "syndicated").

The following data characterizes Feed Awareness:

    * Feed Circulation and Hits: Circulation is a daily measure of feed readership and popularity, recorded over the 
    life of your feed. Hits are a raw measure of request traffic for your feed.
    * Detailed Item Popularity: The popularity of each item published as determined by itemviews and clickthroughs.
    * Item Syndication: Redisplay or repurposing of a feed's content on a third party website that generates traffic (as 
    itemviews and clickthroughs).

The reports and charts you see when using The FeedBurner website are based on the same data. Using AwAPI, you can create 
your own analysis and tracking applications. It's your data. Display it your way!


== Example

require 'awareness_api'

opts = {:uri => 'CommonThread'}

puts AwarenessApi.get_feed_data(opts)
puts AwarenessApi.get_item_data(opts)
puts AwarenessApi.get_resyndication_data(opts)