Historical Daily Kred Points
Delivers a histogram of a user's kred points over time range. Kred scores are normalized using kred points using our algorithim exposed at kred.com/rules.
All histograms default to returning in GMT format
URL: http://api.peoplebrowsr.com/dailypoints
Request - Required Parameters
- app_id (STRING) - Eight Digit ID [ex: 84d8620b]
- app_key (STRING) - Thirty-two digit key [ex: 281014ad8b0fba5adcc88fac7d79999c]
Post app registration, your app id and key can be viewed by going to https://developer.peoplebrowsr.com/admin/applications and clicking "view"
Time Period - Only two of three of these need to be used in a string. First & Last, First & Count, or Last & Count. Last & Count will return results the easiest.
- first (STRING) - Defines the start of the time period. If January 1 2012 to February 21, 2012 was the specification required, start with specifying the the first time point with first=2011-01-01. Alternatively, say the specification was between yesterday and today.
- Example(s): first=2011-01-01 first=1323466328 or first=yesterday
- last (STRING) - Defines the end of a time period. To continue the example above, if the date range specified is January 1, 2012 to February 21, 2011, specify last=2011-02-21. Alternatively say the time period you always wanted to measure was today. One could specify last=today, and then use count to specify 14, 30, up to 1000 days back relative to the time range enabled for the account on the API.
- Example: last=2012-02-21 or last=1318195928 OR last=today OR last=yesterday
- count (STRING) - Count is used as a period proxy to specified time periods. The standard time period is a day, so using count, you would specify the last 30, 60, 90, 100, to 1000 days by specifying last=today & count=30 (or another period length).
- Example: count=1 OR 10 OR 100 OR 1000 to specify the time period backward or forward
Request - Option Parameters
- period (STRING) - Integer of the number of seconds that a period constitutes if account is specified rather than a start/end date.
- Default setting: period=86400 (24 hours x 60 minutes x 60 seconds) or one Day
- Day: Count=30 (30 days)
- Example: &last=yesterday&count=30 - Specifies chart or histogram to return 30 days (periods) of data with reference to default period setting
- Hour: Specify period=3600 (60 minutes x 60 seconds) & Count=24 (hours)
- Example date setting: &last=1323468000&count=24&period=3600 - Returns 1 day of data by hour
- limit (STRING)- Limit search results to the specified number. Limit=20 will only return 20 data points and can be used in histograms or charts.
- number (STRING) - Specifies number of items in non-histogram queries. If the parameter &number=10, the query will only return 10 data points.
- reverse (STRING) - When set to reverse=true, this will reverse the order of the histograms, charts.
Request - Sample URL
http://api.peoplebrowsr.com/dailypoints?last=today&count=30&source=kred&term=pepsi&app_id=4ecb01d1&app_key=8a0548d48e088665c1dddfa68cefee46
Response
Histogram; relational to date range defined. Returns in JSON format. Can also return in CSV if &output=csv is appended as an argument to the call.
Response - Fields
- date (STRING) - Reference time period. Reference "Period" above for how this can be specified.
- count (NUMBERIC) - Number of actions calculated during the time range returned
- influence (NUMBERIC) - Number of influence actions calculated within that time range
- Outreach (NUMBERIC) - Number of outreach actions calculated within that time range
- status (STRING) - The status of your request (values: submitted, processing, waiting (rarely), complete).
Sample Response
{
"data": [
[
"2012-04-16",
{
"count": 278,
"influence": 2787,
"outreach": 246
}
],
[
"2012-04-17",
{
"count": 221,
"influence": 2077,
"outreach": 258
}
],
[
"2012-04-18",
{
"count": 105,
"influence": 981,
"outreach": 84
}
],
[
"2012-04-19",
{
"count": 340,
"influence": 3233,
"outreach": 241
}
],
[
"2012-04-20",
{
"count": 303,
"influence": 3115,
"outreach": 183
}
],
[
"2012-04-21",
{
"count": 40,
"influence": 370,
"outreach": 30
}
],
[
"2012-04-22",
{
"count": 94,
"influence": 980,
"outreach": 0
}
],
[
"2012-04-23",
{
"count": 182,
"influence": 1868,
"outreach": 103
}
],
[
"2012-04-24",
{
"count": 154,
"influence": 1745,
"outreach": 65
}
],
[
"2012-04-25",
{
"count": 67,
"influence": 669,
"outreach": 73
}
],
[
"2012-04-26",
{
"count": 0,
"influence": 0,
"outreach": 0
}
],
[
"2012-04-27",
{
"count": 1442,
"influence": 17508,
"outreach": 217
}
],
[
"2012-04-28",
{
"count": 874,
"influence": 9242,
"outreach": 30
}
],
[
"2012-04-29",
{
"count": 300,
"influence": 3051,
"outreach": 10
}
],
[
"2012-04-30",
{
"count": 4890,
"influence": 51658,
"outreach": 1307
}
],
[
"2012-05-01",
{
"count": 1341,
"influence": 18725,
"outreach": 1085
}
],
[
"2012-05-02",
{
"count": 921,
"influence": 13674,
"outreach": 345
}
],
[
"2012-05-03",
{
"count": 2356,
"influence": 35567,
"outreach": 554
}
],
[
"2012-05-04",
{
"count": 465,
"influence": 4790,
"outreach": 0
}
],
[
"2012-05-05",
{
"count": 45,
"influence": 450,
"outreach": 0
}
],
[
"2012-05-06",
{
"count": 87,
"influence": 870,
"outreach": 0
}
],
[
"2012-05-07",
{
"count": 0,
"influence": 0,
"outreach": 0
}
],
[
"2012-05-08",
{
"count": 800,
"influence": 8960,
"outreach": 240
}
],
[
"2012-05-09",
{
"count": 346,
"influence": 5109,
"outreach": 71
}
],
[
"2012-05-10",
{
"count": 586,
"influence": 8656,
"outreach": 191
}
],
[
"2012-05-11",
{
"count": 632,
"influence": 10224,
"outreach": 203
}
],
[
"2012-05-12",
{
"count": 428,
"influence": 7178,
"outreach": 20
}
],
[
"2012-05-13",
{
"count": 204,
"influence": 5068,
"outreach": 10
}
],
[
"2012-05-14",
{
"count": 433,
"influence": 5756,
"outreach": 175
}
],
[
"2012-05-15",
{
"count": 115,
"influence": 1165,
"outreach": 0
}
]
],
"id": "999-ba160a47dc25ab81097aa0256c15c612",
"request": {
"app_id": "4ecb01d1",
"app_key": "8a0548d48e088665c1dddfa68cefee46",
"count": 30,
"external": true,
"last": 1337065200,
"name": "dailypoints",
"source": "kred",
"term": "pepsi"
},
"status": "complete"
}