Skip to content

Projects

A project is a single Playwright suite tracked by Nijam — usually one per repository. It owns the runs, tests, traces, and history for that suite. An organization can hold as many projects as you need.

Every project has a stable Project ID (a UUID) shown in its settings. The reporter uses it to route uploads to the right project:

['@nijam/pw-reporter', {
apiKey: process.env.NIJAM_API_KEY,
projectId: 'b4fdfc06-76a2-4721-89eb-9d070add8a5a', // ← your project's UUID
}]

The Project ID isn’t a secret — it identifies where runs go. The API key is what authorizes the upload, so that’s the one you keep in CI secrets.

  • Runs — one per playwright test invocation. See Runs & tests.
  • Tests — each spec/test accumulates a history across runs, which powers flakiness scoring.
  • Traces — Playwright traces for failed/timed-out tests.
  • Spec source — the test files Playwright ran, so the test detail view renders inline (opt-out with uploadSource: false).
  • Environments — an optional tag per run (staging, production, …) you can filter by.

A good default is one project per repository. If a single repo runs several independent suites you want to track separately, give each its own project (and its own projectId).