Metrics
Send a metric change event
Metrics
Send a metric change event
Increment or decrement the value of a metric for a user.
POST
/
metrics
/
{key}
/
event
curl --request POST \
--url https://app.trophy.so/api/metrics/{key}/event \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"user": {
"email": "user@example.com",
"tz": "Europe/London",
"id": "18"
},
"value": 750
}'
{
"metricId": "d01dcbcb-d51e-4c12-b054-dc811dcdc623",
"eventId": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
"total": 750,
"achievements": [
{
"metricId": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
"completed": [
{
"id": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
"metricId": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
"metricName": "words written",
"metricValue": 500,
"name": "500 words written",
"achievedAt": "2020-01-01T00:00:00Z"
}
]
}
],
"currentStreak": {
"length": 1,
"frequency": "daily",
"started": "2025-04-02",
"periodStart": "2025-03-31",
"periodEnd": "2025-04-05",
"expires": "2025-04-12"
}
}
Authorizations
Path Parameters
Unique reference of the metric as set when created.
Body
application/json
Response
201
application/json
Created event
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://app.trophy.so/api/metrics/{key}/event \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '{
"user": {
"email": "user@example.com",
"tz": "Europe/London",
"id": "18"
},
"value": 750
}'
{
"metricId": "d01dcbcb-d51e-4c12-b054-dc811dcdc623",
"eventId": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
"total": 750,
"achievements": [
{
"metricId": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
"completed": [
{
"id": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
"metricId": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
"metricName": "words written",
"metricValue": 500,
"name": "500 words written",
"achievedAt": "2020-01-01T00:00:00Z"
}
]
}
],
"currentStreak": {
"length": 1,
"frequency": "daily",
"started": "2025-04-02",
"periodStart": "2025-03-31",
"periodEnd": "2025-04-05",
"expires": "2025-04-12"
}
}