curl --request GET \
--url https://api.shareofsearch.jplus.io/api/v1/dashboard/metrics \
--header 'Authorization: Bearer <token>'[
{
"group": {},
"visibility_score": {
"value": 123,
"evolution": 123
},
"share_of_mentions": {
"value": 123,
"evolution": 123
},
"share_of_citations": {
"value": 123,
"evolution": 123
},
"sentiment_score": {
"value": 123,
"evolution": 123
},
"average_position": {
"value": 123,
"evolution": 123
},
"sentiment_positive": {
"value": 123,
"evolution": 123
},
"sentiment_negative": {
"value": 123,
"evolution": 123
},
"sentiment_neutral": {
"value": 123,
"evolution": 123
}
}
]Aggregated metrics across projects for a client. Can be grouped by brand, country, category, or source. Returns visibility score, share of mentions, share of citations, sentiment score, and average position.
curl --request GET \
--url https://api.shareofsearch.jplus.io/api/v1/dashboard/metrics \
--header 'Authorization: Bearer <token>'[
{
"group": {},
"visibility_score": {
"value": 123,
"evolution": 123
},
"share_of_mentions": {
"value": 123,
"evolution": 123
},
"share_of_citations": {
"value": 123,
"evolution": 123
},
"sentiment_score": {
"value": 123,
"evolution": 123
},
"average_position": {
"value": 123,
"evolution": 123
},
"sentiment_positive": {
"value": 123,
"evolution": 123
},
"sentiment_negative": {
"value": 123,
"evolution": 123
},
"sentiment_neutral": {
"value": 123,
"evolution": 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.
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
Dimensions to group by
brand, country, category, source Filter by sources
Filter by countries
Filter by brands
Filter by categories
Client id
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes