Check server health, DataForge API connectivity and cache status.

List DataForge projects visible to the configured API key.

List versions of a DataForge project.

Get all measures (business metrics) of a project version, paged through automatically. Each measure carries a stable id that the write tools accept. Set include_sql=true to also get generated SQL per measure.

Get all dimensions of a project version. Each dimension carries a stable id and, where bound to a database, a connected_source naming its connection, table and column.

Get all facts of a project version.

Get the normalized semantic context of a project version: project, version, measures, dimensions, facts and counts. Shares one API call and one cache entry with df_get_consolidated_rmd.

Get the full raw export of a project version: RMD content plus dimension groups, fact tables and relationships in one payload.

Drop the cached state of a project version (or the whole project) and re-fetch its RMD snapshot.

List data marts of a project version.

Get one data mart in full: source fact tables, selected measures, facts and dimensions with their aggregation and filter settings.

Get the physical view materialized for a data mart: existence, object type, database, status, staleness and last refresh.

Generate the SQL query of a data mart. Nothing is executed and nothing is stored. A generation failure comes back as succeeded=false with validation_errors, not as an error.

List database connections of a project version. Credentials are never returned. Unsupported engines (e.g. MySQL) are excluded entirely.

Get one connection: host, port, database, schema and username. Set include_db_schema=true to get the full cached table/column schema.

Get the cached schema of a connection (tables and columns). This is a snapshot taken when the connection was last refreshed, not a live query. Use it to pick valid table and column names for write operations.

List dimension groups (shared reference hierarchies) of a version.

Get one dimension group: primary key, member dimensions with their hierarchy levels, and the fact tables related to it.

List fact tables of a project version with element counts.

Get one fact table: assigned measures, dimensions, facts, dimension groups and verification filters. Set include_dependencies=true to get the formula dependency tree of each measure.

List star-schema relationships (fact table to dimension group joins). relationship_type is the raw slug many_to_one.

Get one relationship with its foreign and primary key source objects.

List the owner and every user with explicit access to a project.

List the company's saved Git connections. Credentials are never returned. Requires a company administrator API key.

Get one saved Git connection.

WRITES TO DATAFORGE. Create a project. An initial version is created with it.

WRITES TO DATAFORGE. Update a project's name, description or colour.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a project WITH ALL OF ITS VERSIONS and their entire content. This cannot be undone.

WRITES TO DATAFORGE. Create a project version. Content is cloned from clone_from_version, or from the current global version when omitted. Counts against the licence version limit.

WRITES TO DATAFORGE. Rename a version or make it the global (published) one. Versions have no description field.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a version and all of its content. The current global version cannot be deleted.

WRITES TO DATAFORGE. Create, replace or update a measure in a project version. mode=create adds a new one; mode=replace (PUT) overwrites it and RESETS every optional field you do not pass; mode=update (PATCH) changes only the fields you pass. replace and update require measure_id.

WRITES TO DATAFORGE. Create, replace or update a dimension in a project version. mode=create adds a new one; mode=replace (PUT) overwrites it and RESETS every optional field you do not pass; mode=update (PATCH) changes only the fields you pass. replace and update require dimension_id.

WRITES TO DATAFORGE. Create, replace or update a fact in a project version. mode=create adds a new one; mode=replace (PUT) overwrites it and RESETS every optional field you do not pass; mode=update (PATCH) changes only the fields you pass. replace and update require fact_id.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a measure. Rejected with a conflict if another element's formula references it.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a dimension. Rejected if it belongs to a dimension group or is referenced by a formula.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a fact.

WRITES TO DATAFORGE. Create and/or update many measures in one call. An item with id is updated, an item without one is created. Items are applied in order, each in its own transaction: a partial result comes back with status=partial and a failed[] array addressing rows by index.

WRITES TO DATAFORGE. Create and/or update many dimensions in one call.

WRITES TO DATAFORGE. Create and/or update many facts in one call.

WRITES TO DATAFORGE. Create, replace or update a dimension group. primary_key is the source object of the group's key column.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a dimension group. Rejected while it is assigned to a fact table.

WRITES TO DATAFORGE. Add dimensions to a group, or change the hierarchy level of existing members. Applied all-or-nothing; levels must stay unique.

PERMANENTLY DELETES DATA IN DATAFORGE. Remove one dimension from a group. The dimension itself stays in the RMD.

WRITES TO DATAFORGE. Create, replace or update a fact table. A fact table created via the API has no base physical table; attach elements with df_assign_to_fact_table.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a fact table. Rejected while it has active relationships.

WRITES TO DATAFORGE. Attach existing measures, dimensions, facts or dimension groups to a fact table. Ids are applied in order; already-assigned or unknown ids come back in failed[] with status=partial rather than failing the whole call.

PERMANENTLY DELETES DATA IN DATAFORGE. Detach one element from a fact table. The element itself stays in the RMD.

WRITES TO DATAFORGE. Create, replace or update a verification filter. Pass fact_table_id to target a fact-table filter; omit it for a version-level (global) filter. Element references in conditions are written as [Element name].

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a verification filter.

WRITES TO DATAFORGE. Create, replace or update a star-schema relationship. foreign_key (fact table side) and primary_key (dimension group side) must name the same connection - a join cannot span two databases.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a relationship.

WRITES TO DATAFORGE. Grant or change a user's access level on a project. Downgrade-only: a level above the user's global role is rejected. Requires the caller to be the project owner or a company administrator.

PERMANENTLY DELETES DATA IN DATAFORGE. Remove a user's explicit access to a project.

WRITES TO DATAFORGE. Transfer project ownership. The new owner must belong to the project's company and hold an ownership-capable role.

WRITES TO DATAFORGE. Export a version's configuration to a Git repository. Pass either connection_id (a saved Git connection) or authentication. Exporting an unchanged version creates no commit and returns commit_hash=null.

WRITES TO DATAFORGE. Export a version to a .dfexport.zip archive and return a signed download link. Nothing in DataForge changes, but the archive is stored.

Dry run: validate an import source without writing anything. Returns valid, errors[], warnings[] and element counts.

Dry run: compare an import source with the target version and report what would change, including per-field conflicts. Nothing is written.

PERMANENTLY DELETES DATA IN DATAFORGE. Import a version from Git. target.method=create makes a new version; target.method=replace OVERWRITES THE VERSION IN THE PATH entirely. Run df_preview_import first. conflict_strategy=overwrite also applies deletions.

PERMANENTLY DELETES DATA IN DATAFORGE. Import a version from a local .dfexport.zip archive. On-premises installations only. target_method=replace OVERWRITES the version in the path.

WRITES TO DATAFORGE. Register a Git connection for the company. Requires a company administrator API key. Credentials are stored encrypted and never returned.

WRITES TO DATAFORGE. Replace a saved Git connection's configuration.

PERMANENTLY DELETES DATA IN DATAFORGE. Delete a saved Git connection.

WRITES TO DATAFORGE. Run the five repository checks for a saved Git connection and refresh its stored status. A failed check is reported as status=failed, not as an error.