Get Performance Cards

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

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/performance-cards"

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}/analyses/{project_id}/search/performance-cards', 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}/analyses/{project_id}/search/performance-cards",
  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}/analyses/{project_id}/search/performance-cards"

	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}/analyses/{project_id}/search/performance-cards")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/performance-cards")

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

{
  "performance_score": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "domain_presence_rate": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "average_position": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "share_of_domain_presence": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  }
}

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

Overview Metrics

Get Performance Cards

The Performance scorecard: performance_score, domain_presence_rate, average_position, and share_of_domain_presence aggregated across selected engines, with current and previous values. Uses the shared date/period and dimension filters. Explicit prev_collect_ids override comparison collects; overlap counts only toward current. All values have one decimal. Missing data is 0; prev_value is null without comparison collects, otherwise 0 without eligible data. Average position is domain-based; 0 means no eligible positions. Share of domain presence counts ranked non-citation rows, including non-top rows. AmazonRufus is excluded only from performance_score.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{project_id}

performance-cards

Get Performance Cards

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

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/performance-cards"

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}/analyses/{project_id}/search/performance-cards', 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}/analyses/{project_id}/search/performance-cards",
  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}/analyses/{project_id}/search/performance-cards"

	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}/analyses/{project_id}/search/performance-cards")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/performance-cards")

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

{
  "performance_score": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "domain_presence_rate": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "average_position": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "share_of_domain_presence": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  }
}

{
  "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

project_id

string

required

Query Parameters

prev_collect_ids

string[] | null

Optional comparison collection IDs.

date_start

string<date>

required

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

date_end

string<date> | null

End of the date range (YYYY-MM-DD). Defaults to end of period containing date_start.

period

enum<string>

default:week

Aggregation period: day, week, month, or year

Available options:

day,

week,

month,

year

sources

enum<string>[] | null

Available options:

Bing,

BingAIO,

ChatGPT,

Perplexity,

Google,

GoogleAIO,

GoogleAIMode,

Claude,

Gemini,

AmazonRufus,

Grok,

Copilot,

Mistral,

MuseSpark

thematics

string<uuid>[] | null

Filter by a list of thematic IDs

keyword_type

enum<string>[] | null

Filter by a list of keyword types

Available options:

Generic,

Brand

funnel_stages

enum<string>[] | null

Filter by a list of Funnel Stages

Available options:

ToFu,

MoFu,

BoFu

persona_ids

string[] | null

Filter by a list of persona IDs

topic_ids

string[] | null

Filter by a list of topic IDs

get_neutrals

boolean | null

Filter by to get results related to neutral prompts, without weakness or strength

strength_ids

string[] | null

Filter by a list of strength IDs

weakness_ids

string[] | null

Filter by a list of weakness IDs

Response

Successful Response

The four metrics of the Performance scorecard across the selected engines.

performance_score

Metric · object

required

Rank-weighted own-domain performance, 0-100 with one decimal; AmazonRufus excluded.

Show child attributes

domain_presence_rate

Metric · object

required

Answers with the project's domain over eligible ranked-link answers (%), one decimal.

Show child attributes

average_position

Metric · object

required

Mean best own-domain ranked position per answer, one decimal; 0 without eligible positions.

Show child attributes

Own ranked non-citation links over all ranked non-citation links (%), one decimal; includes non-top rows.

Show child attributes

Overview

Core API

Search API

Get Performance Cards

Authorizations

Path Parameters

Query Parameters

Response