Publish/Unpublish Metric

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"
}

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

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

Authorization

string

required

Bearer token for API authentication. Use your API key from the data app.

Authorization: Bearer dbn_live_abc123...

Content-Type

string

required

Must be set to application/json for all requests.

Content-Type: application/json

Request Body

embedId

string

required

The embed configuration ID where the metric is located.

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

metricId

string

required

The ID of the metric to publish or unpublish.

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

isPublished

boolean

required

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

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

string

The metric ID that was successfully updated on success.

error

object

Error object returned only when the request fails. Not included in successful responses.

Show error properties

code

string

Error code identifying the type of error.

message

string

Human-readable error message describing what went wrong.

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

Import Dashboard

Create Admin Account (Self-Hosted)

Documentation Index

​Authentication

​Headers

​Request Body

​Response

​Examples

​HTTP Status Code Summary

​Possible Errors

Authentication

Headers

Request Body

Response

Examples

HTTP Status Code Summary

Possible Errors