Get Aggregated Insights Metrics

Aggregated metrics across all active projects for a workspace, grouped by optional dimensions (brand, country, category, source, keyword_type). Returns visibility score, share of mentions, share of citations, sentiment score, and average position for the requested date range.

GET /v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics

Get Aggregated Insights Metrics

cURL

curl --request GET \
  --url https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/insights/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

[
  {
    "visibility_score": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "brand_mention_rate": {
      "value": 123,
      "prev_value": 123,
      "unit": "<string>"
    },
    "domain_presence_rate": {
      "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": {}
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

200

application/json

Successful Response

visibility_score · Metric · object · required

Visibility score for this group.

Show child attributes

brand_mention_rate · Metric · object · required

Brand mention rate as a percentage.

Show child attributes

domain_presence_rate · Metric · object · required

Domain presence rate as a percentage.

Show child attributes

sentiment_score · Metric · object · required

Net sentiment score (positive rate minus negative rate).

Show child attributes

average_position · Metric · object · required

Average ranking position. Lower is better.

Show child attributes

sentiment_positive · Metric · object · required

Share of positive citations as a percentage.

Show child attributes

sentiment_negative · Metric · object · required

Share of negative citations as a percentage.

Show child attributes

sentiment_neutral · Metric · object · required

Share of neutral citations as a percentage.

Show child attributes

group · Group · object | null

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

Show child attributes