Get visibility by AI platform

curl --request GET \
  --url https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms"

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

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

print(response.text)

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

fetch('https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms', 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://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms",
  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://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms")

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

{
  "project": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "domain": "<string>",
    "brandName": "<string>"
  },
  "platforms": [
    {
      "platform": "<string>",
      "platformId": "<string>",
      "responses": 123,
      "mentions": 123,
      "brandMentions": 123,
      "responsesWithBrand": 123,
      "citations": 123,
      "brandCitations": 123,
      "sources": 123,
      "brandSources": 123,
      "visibilityRate": 123
    }
  ],
  "totals": {
    "platformsAnalyzed": 123,
    "totalResponses": 123,
    "totalMentions": 123,
    "totalBrandMentions": 123,
    "totalCitations": 123,
    "totalSources": 123,
    "visibilityScore": 123
  },
  "dateRange": {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

Visibility

Get visibility by AI platform

Visibility broken down by AI platform. The same rows appear inside GET /visibility as platforms[]; this endpoint returns that breakdown on its own and can narrow to specific platforms. platform is comma-separated and resolved through the canonical platform map, so it accepts display names (ChatGPT, AI Overviews), aliases (openai, microsoft, xai), and raw model ids alike — platform=chatgpt matches a stored chatgpt-4o without also matching a copilot-gpt-* id, which belongs to Copilot. Filter further with topicId / country / locationId (each must be a UUID; a malformed value returns 400 invalid_argument), and pass unbranded=true or branded=true to filter by prompt brand state. days defaults to 30, max 365.

GET

api

mcp

projects

{projectId}

visibility

platforms

Get visibility by AI platform

curl --request GET \
  --url https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms"

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

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

print(response.text)

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

fetch('https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms', 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://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms",
  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://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://app.searchable.com/api/mcp/projects/{projectId}/visibility/platforms")

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

{
  "project": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "domain": "<string>",
    "brandName": "<string>"
  },
  "platforms": [
    {
      "platform": "<string>",
      "platformId": "<string>",
      "responses": 123,
      "mentions": 123,
      "brandMentions": 123,
      "responsesWithBrand": 123,
      "citations": 123,
      "brandCitations": 123,
      "sources": 123,
      "brandSources": 123,
      "visibilityRate": 123
    }
  ],
  "totals": {
    "platformsAnalyzed": 123,
    "totalResponses": 123,
    "totalMentions": 123,
    "totalBrandMentions": 123,
    "totalCitations": 123,
    "totalSources": 123,
    "visibilityScore": 123
  },
  "dateRange": {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "howToFix": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requiresUpgrade": true,
  "retryable": true,
  "timeout": true,
  "quotaExceeded": true,
  "current": 123,
  "limit": 123,
  "bulkLimitExceeded": true,
  "requested": 123,
  "maxAllowed": 123,
  "details": {
    "formErrors": [
      "<string>"
    ],
    "fieldErrors": {}
  }
}

Authorizations

Authorization

string

header

required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId

string<uuid>

required

The project id.

Query Parameters

days

integer

Lookback window in days. Default and maximum vary by endpoint — see the operation description.

Required range: x >= 1

unbranded

enum<string>

Pass true to restrict every metric to non-branded prompts only.

Available options:

true

branded

enum<string>

Pass true to restrict every metric to branded prompts only.

Available options:

true

platform

string

Comma-separated AI platform filter (e.g. chatgpt,claude,gemini). Accepted values and whether the param is required vary by endpoint — see the operation description.

topicId

string<uuid>

Restrict to a single topic id.

country

string

Comma-separated ISO 3166-1 country codes (e.g. US,GB) or country names.

locationId

string

Comma-separated tracked-location ids.

Response

Visibility by AI platform.

project

object

required

Show child attributes

platforms

object[]

required

One row per AI platform, most responses first. Identical to the summary view's platforms[].

Show child attributes

totals

object

required

Show child attributes

dateRange

object

required

The resolved lookback window for this response.

Show child attributes

Get per-topic visibility Get visibility by location

Get Started

Endpoints

Get visibility by AI platform

Authorizations

Path Parameters

Query Parameters

Response