Get website

GET https://datafa.st/api/v1/admin/websites/{websiteId}

Return full settings for one website — domain, timezone, currency, KPI, tracking exclusions, and feature flags. Sensitive internal fields are stripped from the response.

The path websiteId must match a website your token can access.

Request

Path parameters

websiteId

string

Website ObjectId. From List websites (_id field). Example: 665f0b3c4d2e1a0012345678.

Response

Returns a JSON object with status: "success" and endpoint-specific fields in data.

Response fields

data[]._id

string

Website ObjectId.

data[].domain

string

Website domain.

data[].name

string|null

Human-readable name for the resource or event. The exact meaning depends on the endpoint.

data[].trackingId

string

Script tracking ID.

data[].timezone

string

Timezone used to interpret dates and group analytics buckets. Defaults to the website timezone.

data[].currency

string

Currency code for money values, such as USD or EUR.

data[].kpi

string|null

Configured KPI goal or metric.

data[].kpiColorScheme

string|null

KPI color scheme.

data[].revenueMetric

string|null

Revenue metric preference.

data[].isCookieless

boolean

Whether cookieless tracking is enabled.

data[].includeRenewalRevenue

boolean

Whether renewal revenue is included in KPI calculations.

data[].allowedHostnames

string[]

Allowed hostnames.

data[].excludedIps

string[]

Excluded IPs.

data[].excludedPaths

string[]

Excluded paths.

data[].excludedCountries

string[]

Excluded countries.

data[].excludedHostnames

string[]

Excluded hostnames.

Authentication

Use a dft_ account token with settings:read.

A df_ website API key for the same website can also call this route when the path websiteId matches the key's website. Write access with a df_ key is capped at member level — owner-only actions such as team management require a dft_ token and owner role.

Errors

See API errors for the standard error envelope, auth failures, validation errors, permission errors, and rate limits.

✍️ Something missing? Suggest features.

🤖 AI agent or LLM? Read this page as markdown

{ "status": "success", "data": [{ "_id": "665f0b3c4d2e1a0012345678", "domain": "example.com", "name": "Example", "trackingId": "dfid_abc123", "timezone": "America/New_York", "currency": "USD", "kpi": "signup", "isCookieless": false, "includeRenewalRevenue": true, "allowedHostnames": ["example.com"], "excludedIps": [], "excludedPaths": [], "excludedCountries": [], "excludedHostnames": [] }] }