Skip to main content
POST
/
v2
/
reporting
/
metrics
/
{id}
curl --request POST \
  --url https://production.hifibridge.com/v2/reporting/metrics/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "An Updated Report Title"
}
'
{
  "status": "success",
  "data": {
    "id": "1154d700-bd7d-41d5-8676-87b541baa86e",
    "profileId": "e4c758d7-5475-4505-ba15-e129db0a441f",
    "template": "TRANSACTION_COUNT",
    "name": "An Updated Report Title",
    "params": {
      "createdAfter": "2025-01-01",
      "createdBefore": "2025-12-01",
      "calculationInterval": "week"
    },
    "createdAt": "2025-12-08T22:28:03.922Z",
    "updatedAt": "2025-12-08T22:33:04.112Z"
  },
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

The UUID of the saved metric to update

Body

application/json

Request to update an existing metric

​
name
string

Updated metric name

Required string length: 1 - 100
​
params
object

Updated metric parameters

​
description
string | null

Updated metric description (can be set to null to clear)

Maximum string length: 500

Response

Metric updated successfully

Single metric response

​
status
enum<string>
Available options:
success
​
data
object

A saved metric definition

​
metadata
object