How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datafold BI API

The BI API from Datafold — 15 operation(s) for bi.

Datafold BI API is one of 13 APIs that Datafold publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BI. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 16 operations across 15 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version latest.

Requests are made against a single base URL, https://app.datafold.com.

16 operations 15 paths 10 schemas 1 DELETE3 GET6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
latest
Base URL
https://app.datafold.com/api/v1/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Datafold BI API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Use the 'Authorization' header with the format 'Key '

Paths & Operations 16

Across 15 paths, the API surfaces 16 operations — 1 DELETE, 3 GET, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

BI 16
GET
/api/v1/lineage/bi/
List all integrations
get_all_integrations_api_v1_lineage_bi__get → 200
POST
/api/v1/lineage/bi/dbt/
Create a DBT BI integration
create_dbt_integration_api_v1_lineage_bi_dbt__post body → 200422
PUT
/api/v1/lineage/bi/dbt/{bi_datasource_id}/
Update a DBT BI integration
update_dbt_integration_api_v1_lineage_bi_dbt__bi_datasource_id___put 1 param body → 200422
POST
/api/v1/lineage/bi/hightouch/
Create a Hightouch integration
create_hightouch_integration_api_v1_lineage_bi_hightouch__post body → 200422
PUT
/api/v1/lineage/bi/hightouch/{bi_datasource_id}/
Update a Hightouch integration
change_hightouch_integration_api_v1_lineage_bi_hightouch__bi_datasource_id___put 1 param body → 200422
POST
/api/v1/lineage/bi/looker/
Create a Looker integration
create_looker_integration_api_v1_lineage_bi_looker__post body → 200422
PUT
/api/v1/lineage/bi/looker/{bi_datasource_id}/
Update a Looker integration
update_looker_integration_api_v1_lineage_bi_looker__bi_datasource_id___put 1 param body → 200422
POST
/api/v1/lineage/bi/mode/
Create a Mode Analytics integration
create_mode_integration_api_v1_lineage_bi_mode__post body → 200422
PUT
/api/v1/lineage/bi/mode/{bi_datasource_id}/
Update a Mode Analytics integration
change_mode_integration_api_v1_lineage_bi_mode__bi_datasource_id___put 1 param body → 200422
POST
/api/v1/lineage/bi/powerbi/
Create a Power BI integration
create_powerbi_integration_api_v1_lineage_bi_powerbi__post body → 200422
PUT
/api/v1/lineage/bi/powerbi/{bi_datasource_id}/
Update a Power BI integration
update_powerbi_integration_api_v1_lineage_bi_powerbi__bi_datasource_id___put 1 param body → 200422
POST
/api/v1/lineage/bi/tableau/
Create a Tableau integration
create_tableau_integration_api_v1_lineage_bi_tableau__post body → 200422
PUT
/api/v1/lineage/bi/tableau/{bi_datasource_id}/
Update a Tableau integration
update_tableau_integration_api_v1_lineage_bi_tableau__bi_datasource_id___put 1 param body → 200422
DELETE
/api/v1/lineage/bi/{bi_datasource_id}/
Remove an integration
remove_integration_api_v1_lineage_bi__bi_datasource_id___delete 1 param → 200422
GET
/api/v1/lineage/bi/{bi_datasource_id}/
Get an integration
get_integration_api_v1_lineage_bi__bi_datasource_id___get 1 param → 200422
GET
/api/v1/lineage/bi/{bi_datasource_id}/sync/
Sync a BI integration
resync_integration_api_v1_lineage_bi__bi_datasource_id__sync__get 1 param → 200422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are LookerDataSourceConfig (8 properties), TableauDataSourceConfig (6 properties), PowerBIDataSourceConfig (6 properties), HighTouchDataSourceConfig (5 properties). Each schema is shown below with its type and property counts.

HighTouchDataSourceConfig
object
5 properties 2 required
LookerDataSourceConfig
object
8 properties 4 required
ValidationError
object
3 properties 3 required
TableauDataSourceConfig
object
6 properties 4 required
PowerBIAuthType
string
HTTPValidationError
object
1 property
DbtDataSourceConfig
object
3 properties 1 required
DataSourceBinding
object
2 properties 2 required
PowerBIDataSourceConfig
object
Power BI data source parameters.
6 properties
ModeDataSourceConfig
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datafold-bi-api-openapi.yml Raw ↑

Other APIs Datafold publishes across the network.

Datafold Audit Logs API
Datafold bi_added API
Datafold bi_deleted API
Datafold bi_modified API
Datafold bolt API
Datafold CI API
Datafold Data diffs API
Datafold data_source_added API
Datafold Data sources API
Datafold diff_created API
Datafold Explore API
Datafold Monitors API
Where this information came from

This is an independent, third-party profile of Datafold BI API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.