curl --request GET \
--url https://api.shareofsearch.jplus.io/api/v1/aggregated-brand-sources \
--header 'Authorization: Bearer <token>'{
"total_count": 123,
"items": [
{
"domain": "<string>",
"is_ranked": true,
"is_citation": true,
"engines": [
"<string>"
],
"visibility_score": 123,
"is_my_domain": true,
"nb_total_results": 123,
"nb_my_brand_mentions": 123,
"presence_rate": 123,
"presence_rate_occurrences": 123,
"presence_rate_total": 123,
"rank_or_citation_type": "<string>",
"url": "<string>",
"nb_urls": 123,
"nb_urls_prev_collect": 123,
"nb_total_results_prev_collect": 123,
"nb_my_brand_mentions_prev_collect": 123,
"presence_rate_prev_collect": 123,
"presence_rate_occurrences_prev_collect": 123,
"presence_rate_total_prev_collect": 123,
"avg_ranking": 123,
"avg_ranking_prev_collect": 123,
"competitor_type": "<string>",
"new_sentiment_score": 123,
"new_sentiment_positive_pct": 123,
"new_sentiment_negative_pct": 123,
"new_sentiment_neutral_pct": 123
}
]
}Retrieves aggregated data of brand sources with metrics. Can be grouped by domain or URL. Filter by ALL (default, shows all), SOURCE (citations only), or LINK (ranked only). Supports sorting by: competitor_type, domain/url, type (Link/Source/both), engines count, visibility_score, nb_urls, nb_my_brand_mentions, presence_rate, avg_ranking. NULL values are treated as below 0 in ascending order. When a domain is provided, automatically groups by URL to show all URLs for that domain.
curl --request GET \
--url https://api.shareofsearch.jplus.io/api/v1/aggregated-brand-sources \
--header 'Authorization: Bearer <token>'{
"total_count": 123,
"items": [
{
"domain": "<string>",
"is_ranked": true,
"is_citation": true,
"engines": [
"<string>"
],
"visibility_score": 123,
"is_my_domain": true,
"nb_total_results": 123,
"nb_my_brand_mentions": 123,
"presence_rate": 123,
"presence_rate_occurrences": 123,
"presence_rate_total": 123,
"rank_or_citation_type": "<string>",
"url": "<string>",
"nb_urls": 123,
"nb_urls_prev_collect": 123,
"nb_total_results_prev_collect": 123,
"nb_my_brand_mentions_prev_collect": 123,
"presence_rate_prev_collect": 123,
"presence_rate_occurrences_prev_collect": 123,
"presence_rate_total_prev_collect": 123,
"avg_ranking": 123,
"avg_ranking_prev_collect": 123,
"competitor_type": "<string>",
"new_sentiment_score": 123,
"new_sentiment_positive_pct": 123,
"new_sentiment_negative_pct": 123,
"new_sentiment_neutral_pct": 123
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
domain, url all, source, link competitor_type, domain, url, type, engines, visibility_score, nb_urls, nb_total_results, nb_my_brand_mentions, presence_rate, avg_ranking, sentiment_score, keyword_text, ranks asc, desc Project Id
Collect Ids
Sources
Bing, BingAIO, ChatGPT, Perplexity, Google, GoogleAIO, GoogleAIMode, Claude, Gemini, AmazonRufus Client id
Thematic
Keyword Type
Generic, Brand Competitor Types
BRANDED_WEBSITE, COMMUNITY_HELP_CENTER, COMPARISON_SITE, GOVERNMENT_ACADEMIC, INFLUENCER_CREATOR_BLOG, NEWS_MEDIA, PRODUCT_REVIEW_SITE, QA_FORUM, RETAIL_ECOMMERCE, SPECIALIST_BLOG, WIKI_ENCYCLOPEDIA, UNKNOWN