Skip to content

Architecture ​

API Glimpse finds endpoints from real traffic. A connector in your app sends samples to API Glimpse. You browse endpoints and schemas in the dashboard.

Data flow ​

Your app
  → Connector (samples + API key)
  → API Glimpse (validate key, aggregate per project)
  → Store (schemas + tags)
  → Dashboard (session auth)
PieceRole
ConnectorSamples requests in your app (or at the gateway); sends batches in the background. Supported stacks today include Express, Fastify, NestJS, Next.js, FastAPI, Django, Flask, Go (chi), Spring Boot, ASP.NET Core, Nginx/OpenResty, Kong, and a Node gateway sidecar. See Connectors.
API Glimpse (collect.apiglimpse.com)Accepts batches with your service API key; aggregates per service
API and storeSaves endpoints, schemas, and tags; serves the dashboard and APIs
Dashboard (app.apiglimpse.com)Orgs, projects, services, API keys, endpoints, endpoint detail

Your app talks to the collect URL. Reading endpoints and managing keys goes through the dashboard (session auth).

Components ​

Connector ​

Captures method, path, status, latency, header names, and truncated body field names/types. Removes secrets. Buffers and sends asynchronously so sampling stays off the critical request path. If API Glimpse is unreachable, samples are dropped and your app keeps serving traffic.

See Connectors for what is available now and what is coming soon.

Receiving samples ​

  1. Require a service API key on each batch
  2. Validate the key and map it to a service
  3. Invalid or missing key → reject the batch (no endpoint update)
  4. Rate limit and body size caps
  5. Aggregate samples per service, then update endpoints

Samples are used briefly for aggregation. Long-lived storage is schemas, counters, and tags — not raw bodies.

Dashboard ​

Session auth for humans. Create projects and services, create API keys, and browse endpoints: methods, path templates, merged schemas, and tags.

Services ​

Every endpoint row is scoped to a service (one API you install a connector on). Your API key identifies the service; batches from different services stay separate. Services live under a project (grouping) inside an organization.

Hosting ​

PieceHost
Collectcollect.apiglimpse.com
Dashboardapp.apiglimpse.com
Docsdocs.apiglimpse.com
Marketingapiglimpse.com

Customer config ​

bash
API_SENSOR_AGENT_URL=https://collect.apiglimpse.com
API_SENSOR_KEY=ask_xxx

Endpoint limits ​

Projects may enforce an endpoint limit: new endpoints over the cap are skipped; existing endpoints continue to update. See Concepts.

Signup open on the dashboard · app.apiglimpse.com