API Reference / Sites

Sites

A site is one website you track conversions for. It holds its own flows, and every event belongs to a site. Each account starts with one default site.

The site object

string

Prefixed identifier, e.g. site_29Et…. Use this in URLs.

name

string

Human-friendly label. Defaults to My Website.

domain

string | null

Canonical origin, e.g. https://northwind.com. null until set.

timezone

string

IANA timezone. Defaults to America/New_York.

site_key

string

Short public key used in the install snippet. Not the same as id.

created_at

timestamp

When the site was created.

Endpoints

GET/v1/sitesList the sites on your account.POST/v1/sitesCreate a site.GET/v1/sites/{id}Retrieve a single site.PATCH/v1/sites/{id}Update a site's name, domain, or timezone.DELETE/v1/sites/{id}Delete a site and stop all delivery for it.GET/v1/sites/{id}/install-snippetGet the script tag to embed on the site.GET/v1/sites/{id}/install-statusCheck whether the snippet has been detected.GET/v1/sites/{id}/known-triggersTriggers detected from recent activity on the site.

GET/v1/sites

curl https://app.converly.io/api/v1/sites \
  -H "Authorization: Bearer sk_live_…"

200 OK

{
  "data": [
    {
      "id": "site_29Et…",
      "name": "Northwind",
      "domain": "https://northwind.com",
      "timezone": "America/New_York",
      "site_key": "site_1VQH84sr"
    }
  ],
  "has_more": false,
  "next_cursor": null
}