| Contents:
API URL
http://feedoor.com/api/stats
Method: Get
Request
Parameters
|
Required
|
Name
|
example value
|
Description
|
|
yes
|
sub
|
(your feed address)
|
This is the sub address of your feed,
for example if your feed address is http://blogrss.feedoor.com
then your sub is "blogrss".
|
|
optional
|
days
|
any number
|
Number of days you want to display feed
stats for
|
|
optional
|
uri
|
|
This parameter can be used with
dynamic feeds
only, if you created a dynamic
feed and want to retrieve stats data
for each uri then use this parameter to
pass the value of the uri you want to get,
for example: if you have a dynamic feed
with "blogrss" sub and you have
the following feeds associated
- http://blogrss.feedoor.com/feed/news/asia
- http://blogrss.feedoor.com/feed/sports/soccer
Then uri value of trhese 2 feeds are
|
|
optional
|
output
|
(xml or json)
|
Desired response format. Default value
is "xml"
|
|
optional
|
callback
|
|
Available with JSON output only, this
parameter will wrap your json output in
a callback javascript function.
|
GET
Query Example
http://feedoor.com/api/stats?sub=XXX&days=10
JSON
Rsponse The
following results will be presented when you request
JSON format.
stats
-
sub:
sub domain associated with this stats.
-
hits:
All hits received, including bots hits.
- total:
all hits.
- unique: count 1 hit per
24 hours for each client, if the same
client/person/bot hit the feed
more than once within 24 hours
it will be counted as one hit only.
- visits:
hits received by web browsers and counted
as a real person visit
- total: all visits
- unique: count 1 visit request per
24 hours for each visitor, if the same
person visited the feed more than
once within 24 hours it will
be counted as one visit only.
- days[]:
days
list with each day stats
-
date: date of the day.
-
total: total hits for that day.
-
unique: unique hits for that day
- countries[]:
visits received by country
-
code: country code of 2 letters.
ex: US=united states. Country code
"xx" means unknown
country.
- total:
total visits by country
- unique:
unique visits by country
- charts[]:
chart related to the stats
-
id: chart id.
- title:
chart title
- link:
chart link: charts brought to you
by google, it uses google Charts
API and ready to be displayed.
|
JSON Response Example
XML
Rsponse The
following results will be presented when you request
XML format.
<Stats>
-
sub:
sub domain associated with this stats.
-
<hits>:
All hits received, including bots hits.
- total:
all hits.
- unique: count 1 hit per
24 hours for each client, if the same
client/person/bot hit the feed
more than once within 24 hours
it will be counted as one hit only.
- <visits>:
hits received by web browsers and counted
as a real person visit
- total: all visits
- unique: count 1 visit request per
24 hours for each visitor, if the same
person visited the feed more than
once within 24 hours it will
be counted as one visit only.
- <days>:
days
list with each day stats
-
date: date of the day.
-
total: total hits for that day.
-
unique: unique hits for that day
- <countries>:
visits
received by country
-
<country>
-
code: country code of 2 letters.
ex: US=united states. Country code
"xx" means unknown
country.
- total:
total visits by country
- unique:
unique visits by country
- <charts>:
charts
related to the stats, charts
uses google Charts API and ready to
be displayed.
-
<chart>
-
id: chart id.
- title:
chart title
- link:
chart link
|
XML Response Example
Errors Response
XML Error Example
JSON Error Example
Error Codes and their associated
messages
|
Code
|
Error message
|
|
2
|
Required Parameter is Missing. |
|
3
|
Unknow Error.
|
|