This page lists all responses possible for version 1.0 of our API.

JSON responses are normally provide in a compact format but you can get a pretty (i.e., easier to read for a human) response using parameter `jsonPretty=1`.

ApiEnvelope

Here is the general form of our responses. Any element listed as Option[] indicates that the element may exist in the response or may be missing entirely.

{
  "envelope_ver": "1.0",
  "status": String,
  "msg": String, // human readable status description
  "note": Option[String],
  "data": Option[Result]
}

Specific ApiEnvelopes

Specific ApiEnvelopes are spelled out here.

ApiSuccess

{
  "envelope_ver": "1.0",
  "status": "2.5.0",
  "msg": "success",
  "note": Option[String],
  "data": Result
}

ApiSuccessNoData

{
  "envelope_ver": "1.0",
  "status": "2.5.4",
  "msg": "success (no content)",
  "note": Option[String],
}

ApiSyntaxError

{
  "envelope_ver": "1.0",
  "status": "5.0.1",
  "msg": "error in parameter or argument",
  "note": String,
}

ApiUnimplemented

{
  "envelope_ver": "1.0",
  "status": "5.0.2",
  "msg": "unimplemented",
  "note": String
}

ApiInvalidAuthentication

{
  "envelope_ver": "1.0",
  "status": "5.5.1",
  "msg": "invalid api token",
  "note": Option[String]
}

ApiNoSuchData

{
  "envelope_ver": "1.0",
  "status": "5.5.2",
  "msg": "requested item does not exist",
  "note": Option[String]
}

Results

The following structures are possible Result values that will be found as “data” elements in an ApiEnvelope.

Search

{
  "size": Int,
  "searchString": String,
  "influencers": Array[Influencer]
}

Influencer

{
  "uid": String,
  "name": String,
  "score": Option[ScoreInfo], // Missing on Person query, set on People query
  "contextualInfluence": TermScoreMap,
  "numOutlets": Int,
  "numContent": Int,
  "outlets": Array[Outlet],
  "content": Array[Content],
}

InfluencerList

{
  "influencers": Array[Influencer]
}

Other Objects

The following objects were referenced in the Results section but are not themselves Results.

ScoreInfo

{
  "score": Double,
  "relevance": Double,
  "reach": Double,
  "impact": Double
}

TermScoreMap

{
  String: ScoreInfo
  ...
}

Outlet

{
  "url": String
}

Content

{
  "url": String
}