Feedoor - Entrance to Feed management world

Subscribers API

Get your feed's supscription stats any time and from any where by using our Subscribers API.

Contents:

API URL
Request Parameters
Get Query Example
JSON Response
XML Response
Error Responses

API URL

http://feedoor.com/api/subscribers

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	uri		This parameter can be used with dynamic feeds only, if you created a dynamic feed and want to retrieve subscribers 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 values of trhese 2 feeds are news/asia sports/soccer
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/subscribers?sub=XXX

JSON Rsponse
The following results will be presented when you request JSON format.

subscriptions

sub: sub domain associated with this stats.

Subscribers: holds information abut feed subscribers.
- total: real number of subscribers to the related feed.
- onlinereaders: Number of subscribers subscribed to the feed through an online feed reader service.
- desktopreaders: Number of subscribers subscribed to the feed through desktop feed reader application.
- emailreaders: Number of subscribers subscribed to the feed through Email feed subscription service.

agents[]: list agents subscribers are currently using to read the feed

name: name of the agent.
total: number of subscribers using this agent.

charts[]: chart related to the subscribers, charts use google charts API

id: chart id.
title: chart title
link: chart link

JSON Response Example

{"subscriptions":{ "sub":"blogrss", "subscribers":{ "total":"12", "onlinereaders":"10", "emailreaders":"2", "desktopreaders":"0" }, "agents":[ { "name":"NewsGatorOnline", "total":"7" }, { "name":"BlogLines", "total":"3" }, { "name":"SendMeRss", "total":"2" } ], "charts":[ { "id":"1", "title":"Subscriptions Method", "link":"http://chart.apis.google.com/chart?cht=p&chs=300x200&chd=t:10,2,0&chtt=(+Reader+Type+)&chl=Online|Email|Desktop&chco=CC0000" } ] } }

XML Rsponse
The following results will be presented when you request XML format.

<subscriptions>

sub: sub domain associated with this stats.

<Subscribers>: holds information abut feed subscribers.
- <total>: real number of subscribers to the related feed.
- <onlinereaders>: Number of subscribers subscribed to the feed through an online feed reader service.
- <desktopreaders>: Number of subscribers subscribed to the feed through desktop feed reader application.
- <emailreaders>: Number of subscribers subscribed to the feed through Email feed subscription service.

<agents>: list agents subscribers are currently using to read the feed

<agent>

name: name of the agent.
total: number of subscribers using this agent.

<charts>: chart related to the subscribers, charts use google charts API

<chart>
id: chart id.
title: chart title
link: chart link

XML Response Example

Errors Response

XML Error Example

<error> <code>2</code> <message>Required Parameter is missing</message> </error>

JSON Error Example

{ error:{ "code":"2", "message":"Required Parameter is missing" } }

Error Codes and their associated messages

Code	Error message
2	Required Parameter is Missing.
3	Unknow Error.