API | Pastrank

注意！本API仅供参数，beta版期间，API随时可能发生变更，请及时关注我们发布的最新消息！

PastRank提供多种API形式，你可以直接在你的网页中插入一段代码显示alexa排名趋势的图表，也可以通过直接获取原始数据，我们提供xml/JSON/JSONP数据格式的支持。

提供基于Xml/JSON/JSONP方式的API

调用方式：
采用http的方式调用，用户可以通过访问http://api.pastrank.com/api.php?action=<action>&op=<output>&sites=<sites>&timespan=<timespan>&limit=<limit>进行调用

参数说明

参数名称	参数描述	默认	参数类型	备注
action	动作	getRank	getRank	目前提供一种动作，未来根据需要可能会提供更多的动作
op	输出方式	json	json/xml/jsonp	可选为xml/json/jsonp三种数据之任意格式
callback	回调函数(json)	callback	string	如果op=jsonp，那么请求时可以提供一个callback的参数，以便jsonp调用
sites	要请求数据的域名	请求来源的域名	string	假如你要请求pastrank.com的数据，那么sites=pastrank.com，如果此参数为空，则默认为来源网站的域名。例如，发起请求的网址为http://www.yourdomain.com/index.html，当sites参数为空时，则sites被默认为www.yourdomain.com。注意：要求被请求的域名必需是已经在pastrank申请监控，否则无法请求数据
timespan	请求的时间间隔	0	int	只有对于监控时间超过30天的域名，timespan才有意义，根据PastRank的监控原则，7天内每天进行监控，超过7天后每周监控一次。由于PastRank限制最多只能获取50条数据，当网站被监控的时间超过1年后，将需要使用timespan来获取完整的监控数据。示例：某网站从2008年开始监控，到目前被监控了超过100次，如果我们想获取监控启动到目前的数据，我们需要获取第0,3,6,9...次数据就可以了，那么参数timespan应为3，这样我们可以获取完整的数据，又不违反PastRank的原则。
limit	获取数据的条数	30	int	获取记录的条数，默认为30条，根据目前的原则，最多不能获取超过50条的数据，PastRank保留在不通知用户的情况下进行更改的权利。
startdate	查询的开始时间	null	string	日期格式 yyyy-MM-dd，如：2010-01-01
endate	查询的结束时间	null	string

返回数据

返回数据分为两部分，第一部分是网站信息，xml的xPath表示为：Root/Item/info，JSON/JSONP表示为：data[0].info；第二部分是具体发数据，xml的xPath表示为：Root/Item/<Baidu/Google/Alexa...>，JSON/JSONP表示为：data[0][<Baidu/Google/Alexa...>]
Xml数据格式如下：

 <?xml version="1.0" encoding="utf-8"?>
<Root>
  <Item>
    <info>
      <!--基本信息-->
    </info>
	<!--百度的收录数据-->
    <Baidu>
      <Item>
        <!--每一次抓取数据-->
      </Item>
	  <Item>
        <!--更多的抓取数据-->
      </Item>
    </Baidu>
    <Google>
		<Item>
			<!--google的收录数据-->
		</Item>
    </Google>
    <Alexa>
      <Item>
       	<!--Alexa的排名数据-->
      </Item>
    </Alexa>
  </Item>
</Root>

JOSN/JSONP数据格式如下：

[{ "info": {
//基本信息
},
    "Baidu": [
{
//baidu收录信息
},
{
//更多的baidu收录信息
}],
    "Google": [
{
//google的收录信息
}],
    "Alexa":
[
{
//alexa的排名数据
}]
}]

网站信息：

名称	说明	数据类型	备注
url	网站地址	string
c	被抓取的次数	int	如果没有抓取，则为0
last	最后抓取时间	datetime	如果没有抓取，则返回空值
first	第一次抓取时间	datetime	如果没有抓取，则返回空值

Xml示例：	JSON/JSONP示例

搜索引擎收录

名称	说明	数据类型	备注
ct	搜索引擎一天收录	int
cw	搜索引擎一周收录	int
cm	搜索引擎一个月收录	int
cy	搜索引擎一年收录	int
c	收录引擎所有收录	int
l	搜索引擎链接数	int	baidu采用domain:yourdomain.com的方式查询
d	抓取的日期	datetime
pr	Google的PageRank	int	仅Google包括PageRank参数

Xml示例：	JSON/JSONP示例

Alexa排名

名称	说明	数据类型	备注
r	排名	int	与三个月平均排名相同
l	链接数	int
rc	网站所在国家的排名	int
ya	昨天平均排名	int	如果访问量不大的网站，昨天平均排名通常是0
yp	昨天平均排名同期升幅	int
wa	一周平均排名	int
wp	一周平均排名同期升幅	int
ma	一个月平均排名	int
mp	一个月平均排名同期升幅	int
ta	三个月平均排名	int
tp	三个月平均排名同期升幅	int
d	抓取的日期	datetime

Xml示例：	JSON/JSONP示例

错误信息
如果无法获取数据，则返回一个错误的消息。
Xml返回节点如下：
```
Root>
	<command>false</command>
</Root>
```
JSON/JSONP返回信息如下：
```
{"command":"false"}
```

显示图形化结果的API
通过简单的Javascript的代码调用，就可以在你的网页上显示出各种搜索引擎及排名的曲线图表，你只需要简单的三步就可以完成这些工作。
1. 在你的网页head部分加上<script language="javascript" src="http://api.pastrank.com/javascript/api.js"></script>
2. 在需要显示收录曲线的地方添加如下代码：
```
<script language="javascript">
new getPastRank();  
</script>        
```
就是这么简单，如果你的网站已经申请监控超过了七天，那么将会显示出你网站最近七天的Alexa排名数据。当然，这样的结果不太令人满意，我们需要得到更多的图表。
function getPastRank(options)提供一个options的参数，通过options参数，我们就可以随心所欲地定制自己需要的图表，调用示例：
```
<script language="javascript" src="http://api.pastrank.com/javascript/api.js"></script> 
<script language="javascript">
new getPastRank({
    sites:"pastrank.com",
    dateFormat: "MM月dd日"
});  
</script>        
```
来看options有哪些参数吧

参数名称	参数描述	默认	参数类型	备注
sites	要显示的域名	pastrank.com	string	必需是已经在PastRank中添加监控的域名
timeSpan	时间间隔	0	int	请参考
limit	获取数据的条数	30	int	请参考
showType	显示的类型	Alexa	选项型	Alexa/Search/LinkIn之一，分别表示显示Alexa图表/搜索引擎收录图表/外链的图表
dateFormat	日期格式化参数	MM-dd	string	遵从标准的日期格式化参数，yyyy表示4位的年，MM表示2位的月，dd表示两位的天，示例：yyyy年MM月dd号将显示2010年01月01号这样的日期格式
caption	标题	sites	string	默认显示域名
subcaption	子标题	showType	string	默认显示显示类型，如Alexa
showValues	是否显示值	1	0/1	是否在曲线的锚点上显示相应的数值，仅对Flash图表有效
chartType	图表类型	image	image/flash	image方式使用Google Chart API，实时动态生成曲线图，但某些功能无法使用； flash方式使用FusionCharts，可以生成漂亮的Flash图表，但需要提供本地的FusionCharts的swf文件。为什么要这么做？我该如何做？
container	图表显示的容器的ID		string	图表要显示在什么位置，container提供的参数为唯一的ID，如果此参数为空，则在当前位置创建一个div以显示图表。例如你想把图表显示在<div id="
Alexa相关参数（仅showType为Alexa时，才需要下列参数)
alexa	要显示的alexa曲线	["OneWeekAvg", "OneMonthAvg", "ThreeMonthAvg"]	array	要用参数为：["YesterdayAvg","OneWeekAvg", "OneMonthAvg", "ThreeMonthAvg","RankByCountry"]，分别表示昨天平均排名，一周平均排名，一个月平均排名，三个月平均排名，所在地区平均排名，一般来说，三个月平均排名最准备，七天平均排名波动较大
alexaColor	alexa曲线的颜色	["FF00FF", "00FF00", "FFFF00", "FFCC00"]	array	要求不能小于alexa参数的数组唯数，颜色采用十六进制表示法，不能使用red/green等已命名颜色
alexaText	alexa曲线的名称	alexa	array	要求不能小于alexa参数的数组唯数，示例["一周平均排名","一个月平均排名","三个月平均排名"]
搜索引擎收录相关参数（仅showType为ASearch时，才需要下列参数)
search	要显示的搜索引擎	["Baidu", "Google"];	array	目前可用的搜索引擎为baidu与google，未来提供bing/ask/yahoo等搜索引擎的收录数据，敬请期待
searchText	搜索引擎名称	search	array	要求不能小于search参数的数组唯数
searchType	显示的类型	Count	选项型	CountByToday/CountByWeek/CountByMonth/CountByYear/Count/LinkIn之一的参数，详情请参阅
searchColor	搜索引擎曲线的颜色	["FF00FF", "00FF00"]	array	要求不能小于search参数的数组唯数，颜色采用十六进制表示法，不能使用red/green等已命名颜色
外链相关参数（仅showType为ASearch时，才需要下列参数)
linkIn	要显示的外链	["Baidu", "Google", "Alexa"]	array
linkInText	外链的名称	linkIn	array	要求不能小于linkIn参数的数组唯数
linkInColor	外链曲线的颜色	["FF00FF", "00FF00", "FFFF00"]	array	要求不能小于linkIn参数的数组唯数，颜色采用十六进制表示法，不能使用red/green等已命名颜色
fusionCharts相关参数（仅chartType为flash时，才需要下列参数)
lineSWF	曲线图的flash路径	pastrank.com提供的swf文件	string	基于安全原因，fusionCharts无法实现跨域更新，如果你不需要使用javascript动态更新图表，则可以使用PasgRank提供的swf文件，如果你希望自己可以使用javascript更新图表，那么你需要提供一个本地的swf文件
inverseLineSWF	逆向刻度的flash路径	pastrank.com提供的swf文件	string