Terminology

Terms used in this API documentation are defined below:

Term

Description

Actor An actor represents a person or an organization. An actor can own multiple social accounts, such as Twitter accounts, Facebook accounts LinkedIn accounts etc
PeerIndex Score ("PeerIndex") A relative measure of an actor's online influence (a normalised score of range 0-100, where 0 is the lowest and 100 is the highest). For more information on the PeerIndex score, take a look at the FAQ section on peerindex.com
Activity (score) Normalised 0 to 100 score representing the frequency of which the actor shares content on the social web
Authority (score) Normalised 0 to 100 score representing the degree to which the actor's audience recognises them as a thought leader
Audience (score) Normalised 0 to 100 score representing the effective size of the audience the actor's messages reach
Topic score ("Topical PeerIndex") Topic scores are normalised between 0 and 100 (A topic score of 0 indicates an actor has no recognised interest or authority in a topic. A score of 100 would indicate the actor is likely to be a world leading authority on the topic concerned)
 

Error Responses

The table below outlines the most common error responses that may be returned by the API:

Code

Status

Detail

400 Bad Request Query parameter must include ONE of peerindex_id, twitter_id or twitter_screen_name - see https://developers.peerindex.com/io-docs for examples
403 Forbidden API Key Over Rate Limit - Contact api@peerindex.com to discuss higher usage levels
404 Not Found No PeerIndex data found for actor
503 or 504 Service Unavailable or Gateway Timeout Unable to reach the PeerIndex API - if you are receiving this response and we have not posted about it, please let us know at api@peerindex.com

A word on 404 Errors

The PeerIndex API is based on actor lookup of social profile data. Although our indexes have a wide global coverage of social web users, it will not be 100% complete.

If we do not have data for a particular actor a 404 response will be returned, this can be for a variety of reasons such as:

  • Private or protected social profile account
  • Low or small social footprint
  • New or renamed profile that we have yet to index