Merran documentation API & integrations

The next telemetry summary

GET

/api/telemetry/report

const url = 'http://localhost:3000/api/telemetry/report';
const options = {
  method: 'GET',
  headers: {cookie: 'merran.session_token=<merran.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Server admins only. Exactly what the daily summary would send, whether or not it’s on.

Authorizations

session

Responses

200

The summary.

application/json

object

installId

required

string

version

required

string

install

required

string

arch

required

string

database

required

string

modules

required

object

key

additional properties

boolean

households

required

string

people

required

string

recipes

required

string

Example

{
  "installId": "0199e8b0-5a10-7a01-8b00-0000000000ff",
  "version": "0.1.0",
  "install": "docker",
  "arch": "x64",
  "database": "sqlite",
  "modules": {
    "errorTracking": true,
    "telemetry": true
  },
  "households": "1",
  "people": "2-5",
  "recipes": "100-499"
}

401

Not signed in.

application/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."
    }
  }
}

403

Not allowed.

application/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."
    }
  }
}