POpolar
metrics
public

Update Metric Dashboard

Update a user-defined metric dashboard.

Scopes: metrics:write

patch/v1/metrics/dashboards/{id}

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/metrics/dashboards/{id}
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: metrics:write)
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idstring uuid4 required

The metric dashboard ID.

Request body

namestring nullable

Display name for the dashboard.

metricsstring[] nullable

List of metric slugs to display in this dashboard.

Response

Successful Response

created_atstring date-time required

Creation timestamp of the object.

modified_atstring date-time nullable required

Last modification timestamp of the object.

idstring uuid4 required

The ID of the object.

namestring required

Display name for the dashboard.

metricsstring[] required

List of metric slugs displayed in this dashboard.

organization_idstring uuid4 required

The ID of the organization owning this dashboard.

Changes

No recorded changes to this operation across all 11 revisions of this API.