Get website

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

Get website settings.

Request

Authentication

dft_ account token with settings:read.

Path parameters

Parameter	Type	Description
`websiteId`	string	Website ObjectId used by account tokens to choose which website to query or manage. Website ObjectId. The caller token must have access to this website.

Response

Returns a JSON object with status and endpoint-specific fields.

Response fields

Field	Type	Description
`data[]._id`	string	Website ObjectId.
`data[].domain`	string	Website domain.
`data[].name`	string	null
`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
`data[].kpiColorScheme`	string	null
`data[].revenueMetric`	string	null
`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.

Errors

Common errors include 400 for invalid input, 401 for missing or invalid tokens, 403 for missing permissions or website access, 404 for missing resources, and 500 for server errors.

✍️ 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": [] }] }