Get Ai Visibility Cards

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

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/ai-visibility-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/ai-visibility-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/ai-visibility-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/ai-visibility-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/ai-visibility-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/ai-visibility-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

{
  "ai_visibility_score": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "visibility_score": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "mention_presence_rate": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "average_position": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "share_of_mentions": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "sentiment_score": {
    "value": 123,
    "prev_value": 123
  }
}

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

Overview Metrics

Get Ai Visibility Cards

The metrics of the AI Visibility scorecard (ai_visibility_score, visibility_score, mention_presence_rate, average_position, share_of_mentions, sentiment_score) over every selected engine, with the same filters for the current and comparison periods. Explicit prev_collect_ids override the previous period; overlapping collects count only toward current. prev_value is null without comparison collects, and 0 when they hold no eligible row, except sentiment_score, whose value and prev_value are null without a scored citation. Every value has one decimal, except sentiment_score (two decimals, -1 to +1).

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{project_id}

ai-visibility-cards

Get Ai Visibility Cards

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

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/ai-visibility-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/ai-visibility-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/ai-visibility-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/ai-visibility-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/ai-visibility-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/ai-visibility-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

{
  "ai_visibility_score": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "visibility_score": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "mention_presence_rate": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "average_position": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "share_of_mentions": {
    "value": 123,
    "prev_value": 123,
    "unit": "<string>"
  },
  "sentiment_score": {
    "value": 123,
    "prev_value": 123
  }
}

{
  "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 six metrics of the AI Visibility scorecard, over every selected engine.

ai_visibility_score

Metric · object

required

Mention-based score of the project's brand amongst the 10 first ranked mentions of each answer, 0-100 with one decimal.

Show child attributes

visibility_score

Metric · object

required

Legacy visibility score over domain and brand slots, 0-100 with one decimal.

Show child attributes

mention_presence_rate

Metric · object

required

Answers mentioning the project's brand over answers with a mention, in percent with one decimal.

Show child attributes

average_position

Metric · object

required

Mean best rank of the project's brand mentions per answer, with one decimal. 0 means no eligible mention; lower is better.

Show child attributes

The project's brand mention rows over every mention row, in percent with one decimal.

Show child attributes

sentiment_score

SentimentScoreMetric · object

required

Mean sentiment of the project's scored citations, -1 to +1 with two decimals.

Show child attributes

Overview

Core API

Search API

Get Ai Visibility Cards

Authorizations

Path Parameters

Query Parameters

Response