Skip to main content
POST
Rank handles by project

Authorizations

Authorization
string
header
default:YOUR_KANARIE_API_KEY
required

Preferred Kanarie API key authentication using Authorization: Bearer .

Body

application/json
project_ids
integer[]
Maximum array length: 50
Required range: x >= 1
ecosystems
string[]
Maximum array length: 5
categories
string[]
Maximum array length: 5
days_back
integer
default:30
Required range: 1 <= x <= 365
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: 0 <= x <= 10000
sort_by
enum<string>
default:total_relevance
Available options:
total_relevance,
total_sentiment,
post_count,
avg_relevance,
follower_count
included_attributes
enum<string>[]
Available options:
twitter_profile,
recent_posts,
project_breakdown
attribute_limit
integer
default:5
include_retweets
boolean
default:true
person_only
boolean
default:true
min_relevance
number | null

Response

Ranked handles mentioning the selected projects or filters.

success
boolean
required
error
string | null
data
object
analysis
object
results
object[]
projects
object[]
metadata
object