GET profile/show

Returns the extended PeerIndex profile including the interest graph of a screenname or a twitter id.

URL

Supported formats

json, xml

Request method

GET

Rate limited

True, 10,000 calls per day. More calls are available on a case-by-case basis. Contact us to discuss.

Required parameters

• id

  The twitter screenname or id for whom to return the profile information for

  http://api.peerindex.net/v2/profile/show.json?id=simoncast&api_key=1234567890
• api_key

  Authentication key necessary to authenticate the calls. Not having an api_key will return a missing parameter error

  http://api.peerindex.net/v2/profile/show.json?id=simoncast&api_key=1234567890

Optional parameters

• callback

  The JSONP callback function.

  http://api.peerindex.net/v2/profile/show.json?id=simoncast&callback=parsePi&api_key=1234567890
• identity_id

  Use to fetch profiles using their Twitter id

  http://api.peerindex.net/v2/profile/show.json?id=654321&api_key=1234567890&identity=twitter_id

Errors

• Profile information not found returns empty, but valid, Json or XML stanza, and the http-status is returned as 404
• For standard errors see introduction

Returned fields

• name

  This is the first and last name associated to the profile

• twitter

  The twitter screenname of the profile

• slug

  The slug of the profile on the PeerIndex website. The url of the user's profile is the base URL with the slug i.e. http://www.peerindex.com/[slug]

• authority

  The profile's overall authority. The authority is a rank from 1 to 100, with 100 the highest and 1 the lowest. See here for more information on the metric.

• activity

  The profile's overall activity. The activity is a rank from 1 to 100, with 100 the highest and 1 the lowest. See here for more information on the metric.

• audience

  The profile's overall audience. The audience is a rank from 1 to 100, with 100 the highest and 1 the lowest. See here for more information on the metric.

• peerindex

  The profile's PeerIndex. The PeerIndex is a rank from 1 to 100, with 100 the highest and 1 the lowest. See here for more information on the metric.

• url

  The url of the PeerIndex profile page.

• known

  Indicates whether the profile is an estimate or not. 0 is an estimate and 1 is not an estimate.

• topics

  The top 5 of the profile's topics. NOTE: On some profiles this may return an empty array.

  See here for more information on topics.

• benchmark (Since v2.0)

  The profile's Topic Peerindex, topic activity and topic audience for each of the 9 benchmark topics. Audience is currently a placeholder and will return -1 for all profiles. NOTE: On some profiles this may return an empty array.

• topics_score (Since v2.0)

  Topic PeerIndex in each of the top 5 topics of the profile. NOTE: On some profiles this may return an empty array.

{
   "activity":80,
   "audience":40,
   "authority":39,
   "peerindex":43,
   "known":1,
   "twitter":"matijarijavec",
   "name":"Matija Rijavec",
   "slug":"matijarijavec",
   "url":"http://pi.mu/1",
   "topics":[
      "realtime web",
      "twitter",
      "graphic design",
      "iphone",
      "gmail"
   ],
   "benchmark":[
      {
         "name":"finance, business and economics",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
      {
         "name":"arts, media and entertainment",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
      {
         "name":"health and medical",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
      {
         "name":"technology and internet",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
   ],
   "topics_score":[
      {
         "term":"realtime web",
         "resonance":72
      }
      {
         "term":"twitter",
         "resonance":81
      }
      {
         "term":"graphic design",
         "resonance":81
      }
      {
         "term":"iphone",
         "resonance":75
      }
      {
         "term":"gmail",
         "resonance":40
      }
   ]
}

parsePI({
   "activity":80,
   "audience":40,
   "authority":39,
   "peerindex":43,
   "known":1,
   "twitter":"matijarijavec",
   "name":"Matija Rijavec",
   "slug":"matijarijavec",
   "url":"http://pi.mu/1",
   "topics":[
      "realtime web",
      "twitter",
      "graphic design",
      "iphone",
      "gmail"
   ],
   "benchmark":[
      {
         "name":"finance, business and economics",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
      {
         "name":"arts, media and entertainment",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
      {
         "name":"health and medical",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
      {
         "name":"technology and internet",
         "resonance":84,
         "activity":75,
         "audience":-1
      }
   ],
   "topics_score":[
      {
         "term":"realtime web",
         "resonance":72
      }
      {
         "term":"twitter",
         "resonance":81
      }
      {
         "term":"graphic design",
         "resonance":81
      }
      {
         "term":"iphone",
         "resonance":75
      }
      {
         "term":"gmail",
         "resonance":40
      }
   ]
});

{
   "activity":80,
   "audience":40,
   "authority":39,
   "peerindex":43,
   "known":1,
   "twitter":"matijarijavec",
   "name":"Matija Rijavec",
   "slug":"matijarijavec",
   "url":"http://pi.mu/1",
   "topics":[
      "realtime web",
      "twitter",
      "graphic design",
      "iphone",
      "gmail"
   ]
}