API Guide

Use your API key from Account settings. Send it in the X-Api-Key header.

Idempotency is configured per metric in Metrics > Settings > Advanced. By default it is off. When enabled, write requests for that metric must include Idempotency-Key.

Base URL

https://api.hyperlog.me

Create Datapoint

POST /datapoints
X-Api-Key: your-key
Idempotency-Key: unique-request-key // required only if metric setting is enabled
Content-Type: application/json

{
  "metricId": "metric-guid",
  "created": "2026-02-14T09:30:00Z", // optional
  "valueNumber": 42.5,
  "valueText": "optional note",
  "valueBool": false
}

If created is omitted, it is set to UtcNow.

List Datapoints for a Metric (Paginated)

GET /datapoints/list/{metricId}?page=1&pageSize=1000&start=2026-01-01T00:00:00Z&end=2026-02-14T23:59:59Z
X-Api-Key: your-key

pageSize is capped at 1000. start and end are optional.

Update Datapoint

PUT /datapoints/{id}
X-Api-Key: your-key
Idempotency-Key: unique-request-key // required only if metric setting is enabled
Content-Type: application/json

{
  "metricId": "ignored-on-update",
  "created": "2026-02-14T10:00:00Z", // optional
  "valueNumber": 43.0,
  "valueText": "updated",
  "valueBool": false
}

If created is omitted, the existing created date is preserved.

Delete Datapoint

DELETE /datapoints/{id}
X-Api-Key: your-key
Idempotency-Key: unique-request-key // required only if metric setting is enabled

Idempotency Behavior

If enabled on the metric, missing Idempotency-Key returns 400.
Same key + same payload returns the original response.
Same key + different payload returns 409.

Export Datapoints (JSON)

GET /datapoints/{metricId}/export
X-Api-Key: your-key

Downloads a JSON file for a single metric.

Export Datapoints as CSV

GET /datapoints/{metricId}/export/csv
X-Api-Key: your-key

Downloads a CSV file for a single metric.