Skip to content
Clics privacy-friendly cookieless web analytics documentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

Manage Clics projects with the TypeScript SDK

Copy page
View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this page

Projects

Manage Clics projects with the TypeScript SDK: create sites, list workspaces, and update tracking settings.

A project is the top-level container for a tracked website or app in your Clics workspace. Each project has its own tracking ID, goals, funnels, and analytics data.

Use clics.projects when you need to provision sites programmatically, for example in onboarding flows, internal admin tools, or CI scripts that sync workspace configuration.

What a project includes

Field Description
id Unique project identifier (used in stats queries and tracking setup)
name Display name shown in the dashboard
websiteUrl Primary domain (e.g. example.com): schemes and paths are stripped
allowLocalhost Whether localhost/dev traffic is accepted
status active, deleting, or error

Typical workflow

  1. Create a project with createProject and note the returned id
  2. Install the tracking snippet using that project ID
  3. Verify data with queryStats
  4. Optionally update settings (allowLocalhost, renamed domain) with updateProject

Goals and funnels are always scoped to a project. List every project in a workspace with listProjects when building multi-site automation.

Methods

Access project methods via clics.projects.

Was this page helpful?