Databox API
Databox API as documented publicly: 103 operations. Contract generated from the documentation by API Evangelist (2026-10-29); not the provider's own document.
Operations 103
POST
/v2/accounts
Creates an account in the organization associated with the authenticated user. Only managed accounts can be created through this operation.
#
DELETE
/v2/accounts/{id}
Deletes a specific account from the organization associated with the authenticated user.
#
GET
/v2/billing
Retrieves billing and subscription details for the organization associated with the authenticated user.
#
GET
/v2/billing/invoices
Retrieves a paginated list of invoices for the organization associated with the authenticated user.
#
GET
/v2/connections/{id}/permissions
Retrieves the permissions configured for a specific connection.
#
GET
/v2/dashboards/{id}/metrics
Retrieves the Datablocks and associated metric configurations for a specific dashboard.
#
GET
/v2/data-sources/{id}/permissions
Retrieves the permissions configured for a specific data source.
#
POST
/v2/data-sources/{id}/purge
Permanently deletes all data stored in a specific data source. Data in the original source is not affected.
#
GET
/v2/data-sources/{id}/sync-frequency-options
Retrieves the sync frequencies available for a specific data source.
#
GET
/v2/datasets/modifications/functions
Retrieves the functions available for calculated columns in dataset modifications.
#
GET
/v2/datasets/modifications/rules
Retrieves the rules available for configuring dataset modifications.
#
PATCH
/v2/datasets/{id}
Updates the properties of the specified dataset and returns the updated dataset.
#
GET
/v2/datasets/{id}/column-metadata
Retrieves metadata configured for the columns in the specified dataset.
#
PATCH
/v2/datasets/{id}/column-metadata
Updates metadata for one or more columns in the specified dataset.
#
GET
/v2/datasets/{id}/ingestion-statistics
Retrieves ingestion performance statistics for the specified dataset.
#
GET
/v2/datasets/{id}/lineage
Retrieves the specified dataset’s lineage, including upstream data sources and datasets and downstream datasets and metrics.
#
PATCH
/v2/datasets/{id}/metadata
Updates metadata for the specified dataset and returns the updated metadata.
#
DELETE
/v2/datasets/{id}/modifications
Deletes the modification configured for the specified dataset.
#
GET
/v2/datasets/{id}/modifications
Retrieves the modification configured for the specified dataset.
#
PUT
/v2/datasets/{id}/modifications
Replaces the modification configured for the specified dataset.
#
POST
/v2/datasets/{id}/modifications/preview
Applies the supplied modification settings and returns a preview without saving the changes.
#
PUT
/v2/datasets/{id}/sync-frequency
Updates the scheduled sync frequency for the specified dataset.
#
GET
/v2/datasets/{id}/sync-frequency-options
Retrieves the sync frequencies available for the specified dataset.
#
GET
/v2/datasets/{id}/sync-history
Retrieves a paginated history of sync attempts for the specified dataset.
#
GET
/v2/datasets/{id}/sync-history/statistics
Retrieves sync performance statistics for the specified dataset.
#
POST
/v2/metrics/dimensions/values
Retrieves the available dimension values for one or more metrics.
#
POST
/v2/metrics/drilldown
Retrieves the underlying records for a metric within a specified period.
#
PATCH
/v2/metrics/{id}
Updates the configuration of a specific metric, including its `description`.
#
POST
/v2/metrics/{id}/data
Retrieves a metric's values over a date range, grouped by a granularity, with an optional breakdown by dimensions and optional filters.
#
GET
/v2/metrics/{id}/lineage
Retrieves the specified metric's lineage, including upstream data sources and datasets and metrics.
#
GET
/v2/metrics/{id}/verification
Retrieves the verification status and details for a specific metric.
#
PATCH
/v2/organization
Updates details and settings for the organization associated with the authenticated user.
#
GET
/v2/organization/activity-log
Retrieves a paginated list of activity recorded within the organization.
#
GET
/v2/organization/metadata-options
Retrieves the available business classification, industry, company size, and annual revenue options for populating the organization's metadata.
#
GET
/v2/organization/usage
Retrieves current usage and limits for resources within the organization associated with the authenticated user.
#
GET
/v2/profile/metadata-options
Retrieves the available department and role options for populating a user's profile metadata.
#
Specifications
Schemas & Data
📊
JSONSchema
https://artifacts.apis.io/databox/json-schema/databox-post-v2-datasets-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/databox/json-schema/databox-post-v1-data-sources-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/databox/json-schema/databox-post-v1-datasets-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/databox/json-schema/databox-get-v2-data-sources-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/databox/json-schema/databox-post-v1-datasets-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/databox/json-schema/databox-post-v2-datasets-response-schema.json