TypeScript client

​

Install

npm install @datalyr/client

​

Quick start

import { createDatalyrClient } from "@datalyr/client";

const datalyr = createDatalyrClient({ apiKey: process.env.DATALYR_API_KEY });

// Reads — the path and the response are both typed.
const workspace = await datalyr.get("/workspace");
const funnel = await datalyr.get("/funnel", {
  query: { steps: "pageview,purchase" },
});

// Metric queries
const metrics = await datalyr.post("/metrics", {
  body: { metric_ids: ["visitors", "revenue"] },
});

​

What the client handles for you

• Auth. Sends your key as a bearer token on every request.
• Types. The request parameters and the response shape for each path come from the published OpenAPI contract. A wrong parameter fails at compile time, not at runtime.
• Retries. Retries 429 and 503 responses, and it honors the Retry-After header. Every other error throws immediately with the response body attached.
• Idempotency. Pass an Idempotency-Key on create requests to make retries safe.
• Rate-limit visibility. Read datalyr.rateLimit after any request to see your remaining budget, and whether the limiter is degraded.

​

Writes

// Preview a rule change without applying it.
const preview = await datalyr.post("/rules", {
  body: { dry_run: true, rule: { /* ... */ } },
});

​

Errors

​

Source