Kred Outreach

Returns @names ranked by Kred Outreach Level. Search functions include a term a user has mentioned, bio term (keyword, #hashtag, url, etc.), and/or location over a specified timeframe.

Examples:
term=bio:mommy AND bio:blogger AND pepsi
term=none bio:CEO AND state:CA
term=nike AND bio:runner AND city:san_francisco

URL: http://api.peoplebrowsr.com/kredoutreach?

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 term=yesterday OR term=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
  • source (STRING) - source=twitter
  • term (STRING) - Parameter description (values: @Name, Keyword, Multiple Keywords, #Hashtag, Phrase, or Post) - See Appendix 1: Term Structures for all terms
  • Request - Option Parameters

    • period (STRING) - Integer of the number of seconds that a period constitutes if 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/kredoutreach?last=today&count=10&source=twitter&term=Pepsi&app_id=84d8620b&app_key=281014ad8b0fba5adcc88fac7d79999c
    

    Response

    Responses return 10 data points with JSON format.

    Response - Fields

    1. avatar_url (STRING) - Link to avatar url
    2. id (STRING) - @[name]
    3. followers (NUMERIC)- Follower count from when @name mentioned the term
    4. following (NUMERIC)- Following count from when @name mentioned the term
    5. influence (NUMERIC)- Global Kred Influence Score
    6. outreach (NUMERIC)- Global Kred Outreach Level
    7. status (STRING) - The status of your request (values: submitted, processing, complete)

    Sample Response

    {
        "data": [
            {
                "avatar": "http://a0.twimg.com/profile_images/1121027238/twitterAvatar50_normal.png",
                "followers": 3448,
                "following": 4,
                "id": "favstar50celeb",
                "influence": 708,
                "numeric_id": 189160806,
                "outreach": 11
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/861274492/date_normal.png",
                "followers": 7402,
                "following": 12,
                "id": "EventListing",
                "influence": 825,
                "numeric_id": 138601937,
                "outreach": 11
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1144490979/mokotan_normal.png",
                "followers": 4609,
                "following": 4696,
                "id": "mokou_h_bot",
                "influence": 821,
                "numeric_id": 202531161,
                "outreach": 11
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1460540439/ucv1_normal.jpg",
                "followers": 4327,
                "following": 4293,
                "id": "CARCREY",
                "influence": 886,
                "numeric_id": 163263539,
                "outreach": 11
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1126338980/descarga_normal.jpg",
                "followers": 9166,
                "following": 8793,
                "id": "vallejosjose",
                "influence": 925,
                "numeric_id": 119247286,
                "outreach": 10
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1886920833/IMG_0121_normal.JPG",
                "followers": 9705,
                "following": 9678,
                "id": "douradorogers",
                "influence": 920,
                "numeric_id": 178136330,
                "outreach": 10
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1545490733/image_normal.jpg",
                "followers": 2292,
                "following": 2506,
                "id": "SchoolerLA",
                "influence": 850,
                "numeric_id": 278596403,
                "outreach": 10
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1847699546/y_272f1ab7_normal.jpg",
                "followers": 5399,
                "following": 5135,
                "id": "I_Love_Inna_Ro",
                "influence": 926,
                "numeric_id": 116425078,
                "outreach": 10
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1865105599/420917_3388981093337_1533876426_2967810_1716231785_n_normal.jpg",
                "followers": 28389,
                "following": 21329,
                "id": "DatNiggaTipsy",
                "influence": 916,
                "numeric_id": 108619945,
                "outreach": 10
            },
            {
                "avatar": "http://a0.twimg.com/profile_images/1170017104/twitterAvatarWithHat_normal.png",
                "followers": 2550,
                "following": 1,
                "id": "favstar_pop",
                "influence": 688,
                "numeric_id": 217046870,
                "outreach": 10
            }
        ],
        "id": "999-3f8b2413ac83351821c67947c3799978",
        "request": {
            "app_id": "*****2b5",
            "app_key": "******a29958d5f29a3624c7845f20ab",
            "count": 10,
            "external": true,
            "last": 1331596800,
            "name": "kredoutreach",
            "source": "twitter",
            "term": "pepsi"
        },
        "status": "complete"
    }
    

    PHP Code Sample

    Python Code Sample

    Ruby Code Sample