Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
{project_id}
/
search
/
brands
Competitor Brands
curl --request GET \
  --url https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/search/brands \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "brand": "<string>",
      "total_mentions": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "visibility_score": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "presence_rate": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "presence_rate_total": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "presence_rate_occurrences": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "is_my_brand": true,
      "avg_ranking": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total": 123
  }
}

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

​
brands
string[] | null

Brands to filter by

​
competitor_types
enum<string>[] | null
Available options:
BRANDED_WEBSITE,
COMMUNITY_HELP_CENTER,
COMPARISON_SITE,
GOVERNMENT_ACADEMIC,
INFLUENCER_CREATOR_BLOG,
NEWS_MEDIA,
PRODUCT_REVIEW_SITE,
QA_FORUM,
RETAIL_ECOMMERCE,
SPECIALIST_BLOG,
WIKI_ENCYCLOPEDIA,
UNKNOWN
​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:20
Required range: 1 <= x <= 100
​
search_query
string | null
​
sort_column
enum<string> | null
Available options:
brand,
visibility_score,
nb_mentions,
nb_distinct_keywords,
average_position,
presence_rate
​
sort_direction
enum<string> | null
Available options:
asc,
desc
​
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
​
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

​
data
CompetitorBrand · object[]
required

Items for the current page.

​
pagination
Pagination · object
required

Pagination metadata.