Share of shelf
curl --request GET \
--url https://shelfforce.ai/api/v1/reports/share-of-shelf \
--header 'Authorization: Bearer <token>'import requests
url = "https://shelfforce.ai/api/v1/reports/share-of-shelf"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://shelfforce.ai/api/v1/reports/share-of-shelf', 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://shelfforce.ai/api/v1/reports/share-of-shelf",
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://shelfforce.ai/api/v1/reports/share-of-shelf"
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://shelfforce.ai/api/v1/reports/share-of-shelf")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://shelfforce.ai/api/v1/reports/share-of-shelf")
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": {
"brands": [
{
"brand": "Coca-Cola",
"units": 342,
"sharePercent": 28.5,
"productCount": 8
}
],
"totalUnits": 1200,
"periodDays": 30,
"periodStart": "2026-01-24T00:00:00Z",
"periodEnd": "2026-02-23T23:59:59Z"
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or has been revoked."
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The 'imageUrl' field must be a valid URL."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred. Please try again or contact support with request ID."
}
}Share of shelf
Aggregates shelf unit counts by brand over a time period. Use this to understand brand visibility relative to competitors.
GET
/
api
/
v1
/
reports
/
share-of-shelf
Share of shelf
curl --request GET \
--url https://shelfforce.ai/api/v1/reports/share-of-shelf \
--header 'Authorization: Bearer <token>'import requests
url = "https://shelfforce.ai/api/v1/reports/share-of-shelf"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://shelfforce.ai/api/v1/reports/share-of-shelf', 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://shelfforce.ai/api/v1/reports/share-of-shelf",
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://shelfforce.ai/api/v1/reports/share-of-shelf"
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://shelfforce.ai/api/v1/reports/share-of-shelf")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://shelfforce.ai/api/v1/reports/share-of-shelf")
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": {
"brands": [
{
"brand": "Coca-Cola",
"units": 342,
"sharePercent": 28.5,
"productCount": 8
}
],
"totalUnits": 1200,
"periodDays": 30,
"periodStart": "2026-01-24T00:00:00Z",
"periodEnd": "2026-02-23T23:59:59Z"
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "The provided API key is invalid or has been revoked."
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The 'imageUrl' field must be a valid URL."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred. Please try again or contact support with request ID."
}
}Authorizations
API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...
Query Parameters
Lookback period in days (default 30).
Required range:
1 <= x <= 365Example:
30
Filter by project ID.
Example:
"prj_def456"
Comma-separated list of brand names to include.
Example:
"Coca-Cola,Pepsi,Dr Pepper"
Comma-separated list of categories to include.
Example:
"Beverages,Snacks"
Comma-separated list of ISO 3166-1 alpha-2 country codes.
Example:
"US,GB"
Comma-separated list of retail channels.
Example:
"grocery,convenience"
Response
Share-of-shelf report.
Show child attributes
Show child attributes