Api Industry Home Improvement Kpis

The home-improvement cross-issuer operating-KPI peer table (SF-KPI Phase 2, subcohort-scoped). Returns 404 while the flag is dark or no comparable rows exist. FREE / ungated (public SEC data, OWNER decision 2); anon (no valid session) gets the teaser subset. A big-box retailer comp and a pro distributor's organic growth are NOT comparable, so ?subtype= selects a subcohort (retailer_comp | distributor_organic; default = the richest) and the payload carries partition_options. Comps pin reported. Anti-pooling + NO-rank live in ssr_operating_kpis.build_peer_table. Reuses AirlinePeerTableResponse (partition fields optional).

get/api/industry/home-improvement-kpis

Request

  • Base URL: https://www.oxfordledge.com (the document declares no server; this is the origin it was published from)
  • URL: https://www.oxfordledge.com/api/industry/home-improvement-kpis
  • Auth: none declared

Query parameters

periodstring
subtypestring

Response

Successful Response

industrystring required

KPI industry ('airline').

availableboolean required

False when no comparable rows exist.

partialboolean required

True when an anon teaser subset was returned.

total_carriersinteger required

Total carriers (for the 'see all N' prompt).

period_spreadstring[] required

Distinct periods across carriers (honesty).

provenancestring required

OL-derived-from-SEC provenance stamp.

caveatstring required

B9 not-re-audited + anti-pooling honesty caveat.

methodology_urlstring nullable

/methodology/<slug> 'how we read this'.

context_columnsobject[] nullable

Ordered context-column roster [{key, label}] (#315).

context_captionstring nullable

Provenance caption for the context columns (#315).

partitionstring nullable

Selected partition lane (e.g. 'residential').

partition_labelstring nullable

Selected partition's display label.

period_optionsstring[] nullable

Reporting periods with data, newest first (#289 FE period switcher).

period_selectedstring nullable

The period this table is pinned to; None = newest-per-issuer default.

headline_metricstring nullable

The headline metric every surface leads with (levels or growth).

withheld_metric_countinteger nullable

Anonymous teaser only: metrics withheld from this payload (the n in '{n} more metrics and quarterly history'). Absent for a signed-in caller.

Changes

No recorded changes to this operation across all 1 revision of this API.