Partner APIEndpoint reference
Demand summary
Read grouped totals by evidence class and the scheduled-cohort trend.
GET
/api/partner/v1/demand/summaryRecord totals apply from/to to each current public record's last_seen timestamp. request_trend independently applies the same inclusive timestamps to immutable scheduled cohort release buckets (Monday 00:00 UTC), so a historical release remains in its window after the record later advances. Exact timestamp boundaries are honored; a Monday 00:00 bucket is excluded by from=MondayT12:00:00Z.
Requests require a dedicated bearer token in the Authorization header. This documentation does not execute requests or store credentials. Use the examples in a secure local shell.
Parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
| risk_type | query | No | input_cost_energy, input_cost_food_ag, input_cost_metals_materials, input_cost_technology, ops_disruption_weather, demand_macro, demand_local_event, financing_rates, fx_import_export, promo_marketing, idiosyncratic_supplier, regulatory_policy_cost, equity_market, crypto_price, election_outcome, unmapped | |
| evidence_class | query | No | modeled_gap, observed_gap, explicit_request | |
| business_segment | query | No | food_hospitality, retail, construction_trades, manufacturing, agriculture, transport_logistics, professional_services, technology_crypto, sports_promotion, other, unspecified | |
| coarse_geography | query | No | us_national, us_northeast, us_south, us_midwest, us_west, non_us, multi_region, unspecified | |
| from | query | No | string (date-time) | Inclusive UTC timestamp. For gaps and summary totals this filters current public last_seen; for summary request_trend it independently filters the immutable Monday 00:00 UTC release bucket using the full timestamp. |
| to | query | No | string (date-time) | Inclusive UTC timestamp. For gaps and summary totals this filters current public last_seen; for summary request_trend it independently filters the immutable Monday 00:00 UTC release bucket using the full timestamp. |
Responses
| Status | Meaning |
|---|---|
| 200 | Grouped Demand summary over visible cells only. Small observed and explicit cells are absent and do not contribute to totals. |
| 304 | The weak semantic ETag matches under weak comparison. Response has no body. |
| 400 | Invalid parameter or cursor |
| 401 | Missing or invalid scoped bearer token |
| 409 | A full initial sync or reset is required before incremental pulls can continue. |
| 429 | Request limit reached |
| 503 | Partner Demand service is temporarily unavailable |