Store data and insights API
API operations to read orders, inventory, business health, insights, usage and the store's data lake with SQL.
Read what Product Metrics knows about the store: orders, inventory, business health per shop and product, insights, ad spend usage, and SQL over the data lake.
12 operations. Paths are relative to https://prod-backend.productmetrics.io/api/public/v1; every request needs Authorization: Bearer $PM_TOKEN. See the API overview for authentication, errors and rate limits.
Orders
Business Health and stock
GET /properties/{propertyId}/business-health/shops
The shops of the property, for Business Health.
GET /properties/{propertyId}/business-health/slice
One shop’s Business Health for a window, against a comparison.
GET /properties/{propertyId}/business-health/series
One shop’s weekly Business Health over 13 or 26 weeks.
GET /properties/{propertyId}/business-health/products
One shop’s products with revenue, margin, units and stock.
GET /properties/{propertyId}/inventory
Stock per variant across the property’s shops.
Insights and data
GET /properties/{propertyId}/insights
The stored insight card for one spot.
GET /properties/{propertyId}/analytics/status
Whether the property’s data is ready to read.
POST /properties/{propertyId}/query
Runs one read-only SQL query over the property’s data.
GET /companies/{companyId}/usage/ad-spend
Google Ads spend per property and day.