Skip to main content
GET
Share of shelf

Authorizations

Authorization
string
header
required

API key with sf_live_ prefix. Pass as Authorization: Bearer sf_live_...

Query Parameters

days
integer
default:30

Lookback period in days (default 30).

Required range: 1 <= x <= 365
Example:

30

projectId
string

Filter by project ID.

Example:

"prj_def456"

brands
string

Comma-separated list of brand names to include.

Example:

"Coca-Cola,Pepsi,Dr Pepper"

categories
string

Comma-separated list of categories to include.

Example:

"Beverages,Snacks"

countries
string

Comma-separated list of ISO 3166-1 alpha-2 country codes.

Example:

"US,GB"

channels
string

Comma-separated list of retail channels.

Example:

"grocery,convenience"

Response

Share-of-shelf report.

data
object
required