Docs
Metrics and telemetry ›

Get telemetry

GET/v1/telemetry

Where your metrics and events are sent, and how the last export went.

RequestTypeScript
  1. import { Agental } from "agental-sdk";
  2. const agental = new Agental();
  3. const telemetry = await agental.getTelemetry();
Answer200 OK · TelemetryAnswer
  1. {
  2. "telemetry": object,
  3. }

The account's collector, with the names of its headers and how the last export went.

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 The account's collector, with the names of its headers and how the last export went. telemetry is null when none is set.

TelemetryAnswer1 field
telemetry
object

Errors and other answers

501telemetry_unavailable nothing is sent to a collector here. GET /v1/policy says so as telemetry.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.