Internal API Reference

Public and internal flows, at a glance.

Discover datasets or KPI entities, fetch normalized timeseries or entity-scoped KPI reads, and drop into CE or operator endpoints when needed. Generated from the DataHub API contract and kept browse-only inside DataHub.

Gateway Base URL

Public requests still go through the API gateway, not this Render app.

Authentication

Clients send the key in the request header on gateway traffic.

Coverage

Reference includes public client flows plus internal CE and operator endpoints.

API Map

Core client flows first; internal tools follow in the full reference

Start Here

Discovery

Resolve datasets, search surfaces, and synthetic KPI entities before requesting data. Timeseries discovery stays dataset-scoped; KPI discovery starts from entity lookup.

GET/timeseries/datasets
→
GET/timeseries/search_all
POST/timeseries/search_all
→
GET/timeseries/options
GET/entities/lookup
GET/entities/{entity_id}/kpis

Entity KPI Reads

KPI API

Once the entity and KPI are resolved, request selector options, current values, end-of-day revisions, or PIT reads from the dedicated KPI surface.

GET/kpis
GET/kpis/{kpi_id}
GET/entities/{entity_id}/kpis/{kpi_id}/options
GET/entities/{entity_id}/kpis/{kpi_id}/{freq}/{measure}
GET/entities/{entity_id}/kpis/{kpi_id}/{freq}/{measure}/revisions

Batch APIs

Timeseries

Use batch timeseries fetch for normalized multi-series retrieval when a workflow needs several target series in one request.

POST/timeseries/data

External Writes

Canonical Client Onboarding

Register a dataset source, dry-run entity and series batches, commit points safely, then publish reads when validation passes.

GUIDE Open onboarding guide
POST/canonical/batches:ingest

Agent Skills

Authenticated downloads for Codex-ready DataHub workflows

Download the latest internal skill bundle directly from DataHub, then unzip it into $CODEX_HOME/skills/ before using it in a local Codex session.

Loading skills...