Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TetraScience Data Apps API

The Data Apps API from TetraScience — 12 operation(s) for data apps.

TetraScience Data Apps API is one of 35 APIs that TetraScience publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Data Apps. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and authentication docs.

This API exposes 14 operations across 12 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 4.0.

Requests are made against 5 base URLs: https://api.tetrascience.com, https://api.tetrascience-uat.com, https://api.tetrascience-dev.com, https://api.tetrascience-uat.com, api.tetrascience.com.

14 operations 12 paths 13 schemas 2 DELETE8 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.0
Base URL
https://api.tetrascience.com
Authentication
API Key, API Key, API Key
License
Proprietary
Resource Areas
1

Authentication & Security 3

TetraScience Data Apps API declares 3 security schemes for authenticating requests. An API key is passed in the header as ts-auth-token (token). An API key is passed in the header as x-org-slug (orgSlug). An API key is passed in the header as ts-auth-token (tsAuthToken). By default, every request must be authenticated.

  • token — JWT Token for authentication
  • orgSlug — Your organization slug

Paths & Operations 14

Across 12 paths, the API surfaces 14 operations — 2 DELETE, 8 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Data Apps 14
POST
/v1/dataapps/rules-check
Check how many data apps match the provided access control rules
check-data-app-rules body → 200400401500
DELETE
/v1/dataapps/apps/container/cookies
Clear the selected data app and auth cookies
clear-embed-cookies → 200
DELETE
/v1/dataapps/kv/{appSlug}/{key}
Delete connector key value by key for a data app
delete-data-app-connector-key-value-by-key 4 params → 204400401403404503
GET
/v1/dataapps/kv/{appSlug}/{key}
Fetch connector key value by key for a data app
fetch-data-app-connector-key-value-by-key 4 params → 200400401403404503
GET
/v1/dataapps/apps/{id}/logs/download
Download container logs for a specific data app
download-container-logs 2 params → 200400403404500
POST
/v1/dataapps/data/executeDML
Execute a DML query on external or lakehouse schemas
execute-dml-query body → 200400401500
GET
/v1/dataapps/apps
List installed Data Apps
fetch-all-data-apps 9 params → 200400401503
GET
/v1/dataapps/apps/container/{id}
Fetch container data app by connector or data app ID
fetch-container-data-app 1 param → 200400401403404503
GET
/v1/dataapps/apps/{id}/logs
Fetch container logs for a specific data app
fetch-container-logs 6 params → 200400403404500
GET
/v1/dataapps/apps/{id}
Get Data App details
fetch-data-app-by-id 1 param → 200400404
GET
/v1/dataapps/data/fetchDMLResult
Fetch next chunk for an executed DML statement
fetch-dml-result 2 params → 200400401500
GET
/v1/dataapps/kv/{appSlug}
List connector key value keys for a data app
list-data-app-connector-key-value-keys 3 params → 200400401403503
PUT
/v1/dataapps/kv/{appSlug}
Save connector key values for a data app
save-data-app-connector-key-values 3 params body → 200400401403404503
PUT
/v1/dataapps/apps/{id}/labels
Update Data App labels for access control
update-container-data-app-labels 1 param body → 200400404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are DataApp (19 properties), DataAppProvider (10 properties), DataAppProviderSecret (6 properties), ConnectorKeyValue (5 properties). Each schema is shown below with its type and property counts.

SaveDataAppConnectorKeyValuesRequest
object
1 property 1 required
DMLResult
object
5 properties 5 required
DMLResultSchemaColumn
object
3 properties 3 required
DMLResultSchema
object
2 properties 2 required
PaginatedDataApp
object
2 properties
DataAppConnectorKeyValueKeysResponse
object
1 property
ExecuteDMLRequest
object
3 properties 3 required
DataAppProvider
object
10 properties
ConnectorKeyValuesResponse
object
1 property
DMLResultChunk
object
5 properties 5 required
DataAppProviderSecret
object
6 properties
DataApp
object
19 properties
ConnectorKeyValue
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tetrascience-data-apps-api-openapi.yml Raw ↑

Other APIs TetraScience publishes across the network.

TetraScience Access Groups API
TetraScience Agents API
TetraScience ai-workflows API
TetraScience Attributes API
TetraScience Audit Trail API
TetraScience clusters API
TetraScience Commands API
TetraScience Connectors API
TetraScience Data Acquisition API
TetraScience Data App Providers API
TetraScience databricks API
TetraScience Edit Subscriptions API