Skip to content
merran
GitHubInstall

Merran documentation API & integrations

How telemetry is going

GET
/api/telemetry/status
curl --request GET \
--url http://localhost:3000/api/telemetry/status \
--cookie merran.session_token=<merran.session_token>

Server admins only. Whether the Merran project is taking summaries yet, whether to ask the admin about sending one, and how the last one went.

How it’s going.

Media typeapplication/json
object
receiving
required

Whether the Merran project is taking summaries yet. Until it is, nothing is sent.

boolean
ask
required

Whether to ask the server admin about sending a summary: once, until they answer, unless they’ve chosen in Settings or the environment has.

boolean
last
required

How the last summary went; null before the first.

object
at
required
string
outcome
required
string
Allowed values: sent unreachable refused retired
detail
required

What the receiver said, when it refused the summary.

string | null
totals
required

The public page with every server’s totals.

string

Example

{
"receiving": true,
"ask": false,
"last": {
"at": "2026-10-18T06:12:40.000Z",
"outcome": "sent",
"detail": null
},
"totals": "https://merran.app/telemetry"
}

Not signed in.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

Not allowed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
fields
object
key
additional properties
string

Example

{
"error": {
"code": "not_found",
"message": "There's nothing here.",
"fields": {
"name": "Give it a name."
}
}
}

© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.