Authentication
Datasource APIs
Semantic Layer APIs
Embeds
Data App APIs
Metric APIs
curl --request PUT \
--url https://api.usedatabrain.com/api/v2/data-app/metrics/publish \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"embedId": "embed_abc123",
"metricId": "metric_xyz789",
"isPublished": true
}'
{
"id": "metric_xyz789"
}
curl --request PUT \
--url https://api.usedatabrain.com/api/v2/data-app/metrics/publish \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"embedId": "embed_abc123",
"metricId": "metric_xyz789",
"isPublished": true
}'
{
"id": "metric_xyz789"
}
Metric APIs
Publish/Unpublish Metric
Publish or unpublish metrics in an embed configuration to control which metrics are visible to end users.
curl --request PUT \
--url https://api.usedatabrain.com/api/v2/data-app/metrics/publish \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"embedId": "embed_abc123",
"metricId": "metric_xyz789",
"isPublished": true
}'
{
"id": "metric_xyz789"
}
PUT
/
api
/
v2
/
data-app
/
metrics
/
publish
curl --request PUT \
--url https://api.usedatabrain.com/api/v2/data-app/metrics/publish \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"embedId": "embed_abc123",
"metricId": "metric_xyz789",
"isPublished": true
}'
{
"id": "metric_xyz789"
}
Control the visibility of metrics within an embed by publishing or unpublishing them. Published metrics are visible to end users, while unpublished metrics remain hidden but can be published later.
This endpoint allows you to dynamically control metric visibility without deleting metrics or modifying embed configurations. Useful for staged rollouts, A/B testing, or hiding metrics temporarily.
Authentication
All API requests must include your API key in the Authorization header. Get your API token when creating a data app - see our data app creation guide for details. Finding your API token: For detailed instructions, see the API Token guide.Headers
Bearer token for API authentication. Use your API key from the data app.
Authorization: Bearer dbn_live_abc123...
Must be set to
application/json for all requests.Content-Type: application/json
Request Body
The embed configuration ID where the metric is located.
Show Finding embed IDs
Show Finding embed IDs
- Use the List Embeds API to get all embed IDs
- Check the response when creating an embed
- Available in your data app embed configurations
The ID of the metric to publish or unpublish.
Show Finding metric IDs
Show Finding metric IDs
- Use the Fetch Metrics by Embed API to get metric IDs
- Available in metric URLs in your dashboard
- Returned when creating metrics via API
Set the publication status of the metric.
true: Publish the metric (make it visible to end users)false: Unpublish the metric (hide it from end users)
Show Publication behavior
Show Publication behavior
- Published metrics: Visible in the embed, can be accessed by end users
- Unpublished metrics: Hidden from the embed, but not deleted
- State preservation: Metric configuration remains intact when unpublished
- Quick toggle: Can be republished instantly without recreating
Response
The metric ID that was successfully updated on success.
Examples
HTTP Status Code Summary
| Status Code | Description |
|---|---|
200 | OK - Metric publication status updated |
400 | Bad Request - Invalid request parameters |
401 | Unauthorized - Invalid or missing API key |
500 | Internal Server Error - Server error or invalid IDs |
Possible Errors
| Error Code | HTTP Status | Description |
|---|---|---|
INVALID_REQUEST_BODY | 400 | Missing or invalid parameters |
INVALID_DATA_APP_API_KEY | 401 | Invalid API key |
INVALID_METRIC_ID | 500 | Invalid metric or embed ID |
INTERNAL_SERVER_ERROR | 500 | Server error |
⌘I