Appearance
Time-series datasets and reporting queries.
⚠️ EXPERIMENTAL: This API is subject to change. Schema and behavior may evolve.
graphql
type Datasets {
productMetricSeries(
sku: String!
metric: ProductMetric!
range: DateRangeInput!
interval: TimeGrain!
aggregation: SeriesAggregation
): SeriesResult!
productInventoryByStoreSeries(
sku: String!
metric: InventoryMetric!
range: DateRangeInput!
interval: TimeGrain!
aggregation: SeriesAggregation
storeFilter: StoreFilterInput
storeLimit: Int
): SeriesResult!
}Fields
Datasets.productMetricSeries ● SeriesResult! non-null object
Get a time series for a single product metric. Returns data points bucketed by the specified interval.
Example: Track a product's price changes over the last month with daily buckets.
Datasets.productMetricSeries.sku ● String! non-null scalar
Product SKU to query
Datasets.productMetricSeries.metric ● ProductMetric! non-null enum
Which metric to track
Datasets.productMetricSeries.range ● DateRangeInput! non-null input
Date range for the series
Datasets.productMetricSeries.interval ● TimeGrain! non-null enum
Time granularity for bucketing
Datasets.productMetricSeries.aggregation ● SeriesAggregation enum
How to aggregate values within each bucket (default: LAST)
Datasets.productInventoryByStoreSeries ● SeriesResult! non-null object
Get inventory time series for a product across multiple stores. Returns one series per store, allowing you to compare inventory trends.
Example: Track how inventory levels change at different stores for a popular product.
Note: Limited to 50 stores per query for performance. Use storeFilter to narrow results.
Datasets.productInventoryByStoreSeries.sku ● String! non-null scalar
Product SKU to query
Datasets.productInventoryByStoreSeries.metric ● InventoryMetric! non-null enum
Which inventory metric to track
Datasets.productInventoryByStoreSeries.range ● DateRangeInput! non-null input
Date range for the series
Datasets.productInventoryByStoreSeries.interval ● TimeGrain! non-null enum
Time granularity for bucketing
Datasets.productInventoryByStoreSeries.aggregation ● SeriesAggregation enum
How to aggregate values within each bucket (default: LAST)
Datasets.productInventoryByStoreSeries.storeFilter ● StoreFilterInput input
Optional filter to limit which stores are included
Datasets.productInventoryByStoreSeries.storeLimit ● Int scalar
Maximum number of stores to include (default: 10, max: 50)
Returned By
datasets query