Skip to main content
PUT
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

string
required
Bearer token for API authentication. Use your API key from the data app.
string
required
Must be set to application/json for all requests.

Request Body

string
required
The embed configuration ID where the metric is located.
string
required
The ID of the metric to publish or unpublish.
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)

Response

string
The metric ID that was successfully updated on success.
object
Error object returned only when the request fails. Not included in successful responses.

Examples

HTTP Status Code Summary

Possible Errors