List Shopping Products

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

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/products"

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}/shopping/products', 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}/shopping/products",
  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}/shopping/products"

	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}/shopping/products")
  .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}/shopping/products")

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

{
  "data": [
    {
      "entity_id": "<string>",
      "entity_name": "<string>",
      "engines": [],
      "images": [
        "<string>"
      ],
      "products_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "results_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "product_offers_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_share_of_shelf": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_average_position": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_min_rating": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_max_rating": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_min_price": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_max_price": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_currency": "<string>",
      "products_max_reviews_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "merchants_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "brands_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "brand": "<string>",
      "thematic": "<string>",
      "topic": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total": 123
  }
}

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

Shopping

List Shopping Products

Aggregate shopping product metrics for the selected date range and filters. Each row represents a unique product (or thematic/topic when group_by is set), and carries metrics such as share of shelf, average rank, price, rating, and merchant coverage. All numeric metrics include a prev_value for the comparable previous period. Results are paginated; use page and page_size to navigate. Sorting is configurable via sort_column and sort_direction. When group_by=thematic each row represents a thematic and includes a thematic field. When group_by=topic each row represents a topic and includes thematic and topic fields.

GET

organizations

{organization_id}

workspaces

{workspace_id}

analyses

{project_id}

shopping

products

List Shopping Products

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

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{project_id}/shopping/products"

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}/shopping/products', 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}/shopping/products",
  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}/shopping/products"

	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}/shopping/products")
  .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}/shopping/products")

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

{
  "data": [
    {
      "entity_id": "<string>",
      "entity_name": "<string>",
      "engines": [],
      "images": [
        "<string>"
      ],
      "products_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "results_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "product_offers_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_share_of_shelf": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_average_position": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_min_rating": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_max_rating": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_min_price": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_max_price": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "products_currency": "<string>",
      "products_max_reviews_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "merchants_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "brands_count": {
        "value": 123,
        "prev_value": 123,
        "unit": "<string>"
      },
      "brand": "<string>",
      "thematic": "<string>",
      "topic": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total": 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

brands

string[] | null

Restrict results to products whose catalogue brand matches one of these brand names.

product_catalog_ids

string[] | null

Restrict results to products linked to one of these product catalogue IDs.

merchants

string[] | null

Restrict results to products offered by one of these merchant brand names.

string | null

Restrict results to products whose catalogue name contains this search term.

group_by

enum<string> | null

Group results by 'thematic' or 'topic' instead of by product. When set, each row aggregates all products within the group and exposes thematic (both modes) and topic (topic mode only) fields.

Available options:

thematic,

topic

page

integer

default:1

Page number (1-based).

Required range: x >= 1

page_size

integer

default:20

Number of products per page.

Required range: 1 <= x <= 1000

sort_column

enum<string> | null

Metric to sort by. Defaults to results_count (descending) when omitted.

Available options:

results_count,

products_count,

products_average_position,

products_price,

products_rating,

products_reviews_count,

merchants_count,

brands_count,

products_share_of_shelf

sort_direction

enum<string> | null

Sort direction. Defaults to DESC when omitted.

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

ShoppingProductTopicItem · object[]

required

Items for the current page.

Show child attributes

pagination

Pagination · object

required

Pagination metadata.

Show child attributes

Get Shopping Overview

List Shopping Brands

Overview

Core API

Search API

List Shopping Products

Authorizations

Path Parameters

Query Parameters

Response