Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
search
/
insights
/
metrics
Get Aggregated Insights Metrics
curl --request GET \
  --url https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics \
  --header 'Authorization: Bearer <token>'
[
  {
    "visibility_score": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "share_of_mentions": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "share_of_citations": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "sentiment_score": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "average_position": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "sentiment_positive": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "sentiment_negative": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "sentiment_neutral": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "group": {}
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organization_id
string
required
​
workspace_id
string
required

Query Parameters

​
date_start
string<date>
required

Start of the date range (YYYY-MM-DD)

​
date_end
string<date>
required

End of the date range (YYYY-MM-DD)

​
period
enum<string>
default:week

Comparison period granularity

Available options:
week,
month
​
dimensions
enum<string>[] | null

Dimensions to group by

Available options:
brand,
country,
category,
source,
keyword_type
​
sources
enum<string>[] | null

Filter by sources

Available options:
Bing,
BingAIO,
ChatGPT,
Perplexity,
Google,
GoogleAIO,
GoogleAIMode,
Claude,
Gemini,
AmazonRufus
​
countries
enum<string>[] | null

Filter by countries

Available options:
AR,
AT,
AU,
AE,
BH,
BE,
BO,
BR,
CA,
CN,
CO,
DK,
EC,
ES,
FI,
FR,
DE,
GB,
HU,
ID,
IE,
IL,
IN,
IT,
JP,
KR,
KW,
LU,
MA,
MX,
MY,
NG,
NL,
NO,
PH,
PK,
PL,
PT,
QA,
RO,
SA,
SE,
SG,
CH,
TH,
TR,
TW,
US,
VN,
ZA
​
brands
string[] | null

Filter by brands

​
categories
string[] | null

Filter by categories

​
keyword_types
string[] | null

Filter by keyword types (Brand or Generic)

Response

Successful Response

​
visibility_score
Metric · object
required

Visibility score for this group.

​
share_of_mentions
Metric · object
required

Share of mentions as a percentage.

​
share_of_citations
Metric · object
required

Share of citations as a percentage.

​
sentiment_score
Metric · object
required

Net sentiment score (positive rate minus negative rate).

​
average_position
Metric · object
required

Average ranking position. Lower is better.

​
sentiment_positive
Metric · object
required

Share of positive citations as a percentage.

​
sentiment_negative
Metric · object
required

Share of negative citations as a percentage.

​
sentiment_neutral
Metric · object
required

Share of neutral citations as a percentage.

​
group
Group · object | null

Dimension group this row belongs to (e.g. {'brand': 'Acme'}). Null when no dimensions requested.