Top Countries

The top countries out of the posts mentioning the term, ordered by frequency. This information is gathered using a combination of the user's location field, and geo data, if it is turned on.

URL: http://api.peoplebrowsr.com/topcountries

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 OR last=yesterday OR last=today
• 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 "count" 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: &first=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: &first=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/topcountries?last=yesterday&count=10&source=twitter&term=Pepsi&app_id=12345678&app_key=381014ad8b0fba5adcc88fac7d79f99c

Response

Relational to country list defined. May use limit to specify number returned; to execute add &limit=#

Response - Fields

1. country(STRING) - Country Code
2. frequency(STRING) - Frequency of mention within Country
3. status (STRING) - The status of your request (values: submitted, processing, complete)

Sample Response

{ "data": [ [ "US", 14062 ], [ "None", 8344 ], [ "BR", 4829 ], [ "AR", 1762 ], [ "GB", 1332 ], [ "VE", 1037 ], [ "CA", { "data": [ [ "CA", 4211 ], [ "NY", 3778 ], [ "FL", 2265 ], [ "PA", 1976 ], [ "TX", 1905 ], [ "IL", 1889 ], [ "None", 1596 ], [ "OH", 1396 ], [ "MI", 1331 ], [ "NC", 1282 ], [ "GA", 1143 ], [ "CO", 1072 ], [ "MO", 919 ], [ "IN", 913 ], [ "VA", 882 ], [ "MA", 811 ], [ "OK", 798 ], [ "MD", 793 ], [ "KY", 704 ], [ "TN", 667 ], [ "AZ", 646 ], [ "WA", 513 ], [ "WI", 511 ], [ "AL", 509 ], [ "SC", 500 ], [ "MN", 475 ], [ "LA", 453 ], [ "NJ", 447 ], [ "CT", 435 ], [ "DC", 406 ], [ "NV", 302 ], [ "WV", 268 ], [ "KS", 263 ], [ "OR", 260 ], [ "AR", 224 ], [ "IA", 223 ], [ "MS", 223 ], [ "NE", 222 ], [ "UT", 193 ], [ "RI", 162 ], [ "HI", 142 ], [ "DE", 133 ], [ "NH", 97 ], [ "NM", 94 ], [ "AK", 87 ], [ "WY", 82 ], [ "ME", 79 ], [ "ID", 62 ], [ "SD", 44 ], [ "MT", 40 ], [ "ND", 37 ], [ "VT", 33 ], [ "Mt", 26 ], [ "California", 1 ] ], "id": "999-b292ecebefe5dc3a15d2d4b03df11d3f", "request": { "app_id": "12345678", "app_key": "381014ad8b0fba5adcc88fac7d79f99c", "count": 30, "external": true, "last": 1321488000, "name": "top-usarea", "source": "twitter", "term": "pepsi" }, "status": "complete" }