Documentation · TimFid

Quickstart

Send your first event in under five minutes. You'll need an organization API key, which is issued by your TimFid administrator. If you don't have one, contact your account manager.

npm install @timfid/sdk

import { TimFid } from '@timfid/sdk';

const tf = new TimFid({ apiKey: process.env.TIMFID_API_KEY });

await tf.track('checkout.completed', {
  userId: 'u_1029',
  amount: 49.0,
  currency: 'USD',
  region: 'us-west',
});

Authentication

All API requests must include a bearer token in the Authorization header:

curl https://api.timfid.com/v1/events \
  -H "Authorization: Bearer $TIMFID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event":"page.view","properties":{"path":"/"}}'

Requests without a valid key receive a 401 Unauthorized response. Keys are scoped per environment (production, staging) and can be rotated at any time from the console.

Ingest API

The ingest endpoint accepts single events or batches of up to 1,000. Events are durably buffered and acknowledged within milliseconds.

POST /v1/events — ingest one or more events
POST /v1/events/batch — high-throughput batch ingest
GET /v1/query — run an analytical query
GET /health — service health probe

SDKs

Official SDKs are available for Node.js, Python, Go, Ruby, and the browser. Community SDKs cover Rust, PHP, and Java.

Changelog

v1.42 — 2026-05-28

Added seasonal baselines to anomaly alerts; reduced P99 query latency by 18%.

v1.41 — 2026-05-06

New batch ingest endpoint; SCIM provisioning for Enterprise.

v1.40 — 2026-04-19

Edge regions expanded to 38; dashboard embedding with signed URLs.

Looking for the full API reference? It's available inside the console once your account is provisioned.

Developer documentation