Authentication
Datasource APIs
Semantic Layer APIs
Workspace APIs
Embeds
Data App APIs
Metric APIs
curl --request POST \
--url https://api.usedatabrain.com/api/v2/workspace/metrics \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "my-workspace"
}'
{
"data": [
{
"name": "Monthly Revenue",
"metricId": "metric_abc123"
},
{
"name": "Active Users",
"metricId": "metric_def456"
}
],
"error": null
}
curl --request POST \
--url https://api.usedatabrain.com/api/v2/workspace/metrics \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "my-workspace"
}'
{
"data": [
{
"name": "Monthly Revenue",
"metricId": "metric_abc123"
},
{
"name": "Active Users",
"metricId": "metric_def456"
}
],
"error": null
}
Embedding API
Fetch Metrics by Workspace
Retrieve metrics from a workspace with optional pagination support.
curl --request POST \
--url https://api.usedatabrain.com/api/v2/workspace/metrics \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "my-workspace"
}'
{
"data": [
{
"name": "Monthly Revenue",
"metricId": "metric_abc123"
},
{
"name": "Active Users",
"metricId": "metric_def456"
}
],
"error": null
}
POST
/
api
/
v2
/
workspace
/
metrics
curl --request POST \
--url https://api.usedatabrain.com/api/v2/workspace/metrics \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"workspaceName": "my-workspace"
}'
{
"data": [
{
"name": "Monthly Revenue",
"metricId": "metric_abc123"
},
{
"name": "Active Users",
"metricId": "metric_def456"
}
],
"error": null
}
Retrieve metrics available in a workspace. Use this endpoint to discover metrics for provisioning and embedding in your application.
This endpoint operates at the workspace level using a service token. Use the workspace name to scope which metrics are returned. Supports pagination for workspaces with many metrics.
Authentication
This endpoint requires a service token in the Authorization header. Service tokens differ from data app API keys and provide organization-level permissions. To access your service token:- In Settings page, navigate to the Service Tokens section.
- Click the “Generate Token” button to create a new service token if you don’t have one already.
Headers
Bearer token for API authentication. Use your service token.
Authorization: Bearer dbn_live_abc123...
Must be set to
application/json for all requests.Content-Type: application/json
Request Body
Name of the workspace to fetch metrics from. Must match an existing workspace in your organization.
Show Finding workspace names
Show Finding workspace names
- Use the List Workspaces endpoint to see all available workspaces
- Names are case-sensitive
- Must be an exact match
Enable pagination to retrieve metrics in batches of 10.
true: Enable pagination with page-based retrieval (10 items per page)false(default): Return all metrics in a single response
Show When to use pagination
Show When to use pagination
- Use pagination when you have more than 20 metrics in a workspace
- Improves response times for large datasets
- Each page returns up to 10 metrics
The page number to retrieve when pagination is enabled. Pages are 1-indexed.Note: This parameter is only used when
isPagination is set to true.Response
Examples
HTTP Status Code Summary
| Status Code | Description |
|---|---|
200 | OK - Metrics retrieved successfully |
400 | Bad Request - Invalid request parameters |
401 | Unauthorized - Invalid or missing API key |
500 | Internal Server Error - Server error occurred |
Possible Errors
| Error Code | HTTP Status | Description |
|---|---|---|
INVALID_REQUEST_BODY | 400 | Missing or invalid request body parameters |
WORKSPACE_ID_ERROR | 400 | Workspace name does not exist |
INVALID_DATA_APP_API_KEY | 401 | Invalid or expired API key |
INTERNAL_SERVER_ERROR | 500 | Server error |
Next Steps
Fetch Dashboards by Workspace
Retrieve dashboards from a workspace
List Workspaces
List all workspaces in your organization
Create Workspace
Create a new workspace for your analytics environment
Guest Token API
Generate secure tokens for embedded access
⌘I