Source: https://datafa.st/docs/api/account
Markdown source: https://datafa.st/docs/api/account.md
Description: Manage websites, account tokens, website API keys, funnels, alerts, team members, and integrations.

# Account API

Use the Account API when a backend, script, or AI agent needs to manage DataFast resources directly: websites, account tokens, website API keys, funnels, alerts, team members, integrations, and settings.

These endpoints are public REST endpoints. You do not need to use the CLI to call them.

Most Account API routes require a `dft_` account token. Some website-scoped routes also accept a `df_` website API key when the key belongs to the same `websiteId`. Read [authentication and scopes](/docs/api/authentication) before giving an agent write access.

> The [DataFast CLI](/docs/cli-introduction) uses these same endpoints under the hood. Use the CLI when you want a terminal workflow, and use the REST API when you want to call DataFast from your own code.

## Get an account API token

Create account API tokens in [Account settings -> API](https://datafa.st/dashboard/settings?tab=api). Use a `dft_` token for account automation, CLI sessions, and AI agents that need to manage websites, funnels, alerts, team members, integrations, or API keys.

![Create a DataFast account API token](/blog-how-to-get-datafast-account-api-key.jpg)

## Base path

```txt
https://datafa.st/api/v1/admin
```

## Endpoint groups

- [Admin account](/docs/api/account/account)
- [Access tokens](/docs/api/account/access-tokens)
- [Websites](/docs/api/account/websites)
- [Website keys](/docs/api/account/website-keys)
- [Goals](/docs/api/account/tracked-goals)
- [Funnels](/docs/api/account/funnels)
- [Alerts](/docs/api/account/alerts)
- [Team](/docs/api/account/team)
- [Integrations](/docs/api/account/integrations)

## Account endpoints

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [Get account](/docs/api/account/account/retrieve) | GET | `/account` | `analytics:read` | Get current user profile and plan info |
| [Update account](/docs/api/account/account/update) | PUT | `/account` | `analytics:read` | Update current user name |

Update account name:

```sh
curl -X PUT "https://datafa.st/api/v1/admin/account" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"Jane Doe"}'
```

## Account tokens

Use account tokens for CLI sessions, backend automation, and AI agents.

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [List access tokens](/docs/api/account/access-tokens/list) | GET | `/access-tokens` | `api-keys:read` | List account tokens |
| [Create access token](/docs/api/account/access-tokens/create) | POST | `/access-tokens` | `api-keys:write` | Create an account token. The raw `dft_` token is returned once |
| [Delete access token](/docs/api/account/access-tokens/delete) | DELETE | `/access-tokens/{tokenId}` | `api-keys:write` | Revoke an account token |

Create a scoped token:

```sh
curl -X POST "https://datafa.st/api/v1/admin/access-tokens" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Read only agent",
    "permissions": ["analytics:read", "websites:read", "funnels:read"],
    "websiteIds": ["YOUR_WEBSITE_ID"]
  }'
```

## Websites

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [List websites](/docs/api/account/websites/list) | GET | `/websites` | `websites:read` | List websites available to the token |
| [Create website](/docs/api/account/websites/create) | POST | `/websites` | `websites:write` | Create a website |
| [Get website](/docs/api/account/websites/retrieve) | GET | `/websites/{websiteId}` | `settings:read` | Get website settings |
| [Update website](/docs/api/account/websites/update) | PUT | `/websites/{websiteId}` | `settings:write` | Update website settings |
| [Delete website](/docs/api/account/websites/delete) | DELETE | `/websites/{websiteId}` | `websites:write` | Currently returns `403`; website deletion is dashboard-only |

Create a website:

```sh
curl -X POST "https://datafa.st/api/v1/admin/websites" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "example.com",
    "timezone": "America/New_York",
    "name": "Example"
  }'
```

Update website settings:

```sh
curl -X PUT "https://datafa.st/api/v1/admin/websites/YOUR_WEBSITE_ID" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New name",
    "kpi": "signup",
    "kpiColorScheme": "green",
    "includeRenewalRevenue": true
  }'
```

Common updatable fields include `domain`, `name`, `timezone`, `currency`, `kpi`, `kpiColorScheme`, `revenueMetric`, `isCookieless`, `includeRenewalRevenue`, `allowedHostnames`, `excludedIps`, `excludedPaths`, `excludedCountries`, and `excludedHostnames`.

Related CLI docs: [websites](/docs/cli-websites).

## Website API keys

Website API keys start with `df_` and are scoped to one website.

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [List website keys](/docs/api/account/website-keys/list) | GET | `/websites/{websiteId}/apikeys` | `api-keys:read` | List website API keys |
| [Create website key](/docs/api/account/website-keys/create) | POST | `/websites/{websiteId}/apikeys` | `api-keys:write` | Create a `df_` key. The raw key is returned once |
| [Roll website key](/docs/api/account/website-keys/roll) | PUT | `/websites/{websiteId}/apikeys/{apiKeyId}` | `api-keys:write` | Roll an API key and return the new raw key once |
| [Delete website key](/docs/api/account/website-keys/delete) | DELETE | `/websites/{websiteId}/apikeys/{apiKeyId}` | `api-keys:write` | Revoke an API key |

Create a website API key:

```sh
curl -X POST "https://datafa.st/api/v1/admin/websites/YOUR_WEBSITE_ID/apikeys" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production key"}'
```

## Goals

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [List tracked goals](/docs/api/account/tracked-goals/list) | GET | `/websites/{websiteId}/goals` | `settings:read` | List tracked goals ordered by frequency |

Use this endpoint when building a UI or agent flow that needs to choose from existing goals before setting a KPI, creating an alert, or creating a funnel.

To send goal events and query goal analytics, use [Goals](/docs/api/website/goals).

## Funnels

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [List funnels](/docs/api/account/funnels/list) | GET | `/websites/{websiteId}/funnels` | `funnels:read` | List active funnels |
| [Create funnel](/docs/api/account/funnels/create) | POST | `/websites/{websiteId}/funnels` | `funnels:write` | Create a funnel |
| [Update funnel](/docs/api/account/funnels/update) | PUT | `/websites/{websiteId}/funnels/{funnelId}` | `funnels:write` | Update a funnel |
| [Delete funnel](/docs/api/account/funnels/delete) | DELETE | `/websites/{websiteId}/funnels/{funnelId}` | `funnels:write` | Soft-delete a funnel |

Create a funnel:

```sh
curl -X POST "https://datafa.st/api/v1/admin/websites/YOUR_WEBSITE_ID/funnels" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Signup funnel",
    "steps": [
      { "name": "Landing page", "type": "pageview", "url": "/" },
      { "name": "Signup page", "type": "pageview", "url": "/signup" },
      { "name": "Signed up", "type": "goal", "goalName": "signup" }
    ]
  }'
```

Funnels need 2 to 8 steps. A step can be a `pageview` with a `url`, or a `goal` with a `goalName`.

To view funnel results, use [funnel analytics](/docs/api/website/analytics/funnel-results). Related CLI docs: [funnels](/docs/cli-funnels).

## Alerts

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [List alerts](/docs/api/account/alerts/list) | GET | `/websites/{websiteId}/alerts` | `alerts:read` | List alerts |
| [Create alert](/docs/api/account/alerts/create) | POST | `/websites/{websiteId}/alerts` | `alerts:write` | Create an alert |
| [Update alert](/docs/api/account/alerts/update) | PUT | `/websites/{websiteId}/alerts/{alertId}` | `alerts:write` | Update an alert |
| [Delete alert](/docs/api/account/alerts/delete) | DELETE | `/websites/{websiteId}/alerts/{alertId}` | `alerts:write` | Delete an alert |
| [Get alert history](/docs/api/account/alerts/history) | GET | `/websites/{websiteId}/alerts/history` | `alerts:read` | Get recent alert trigger history |

Create an alert:

```sh
curl -X POST "https://datafa.st/api/v1/admin/websites/YOUR_WEBSITE_ID/alerts" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New signup",
    "trigger": { "goalName": "signup" },
    "template": {
      "subject": "New signup",
      "message": "A visitor completed signup."
    },
    "isEnabled": true
  }'
```

Alert history supports `alertId` and `limit` query parameters:

```txt
GET /api/v1/admin/websites/{websiteId}/alerts/history?alertId={alertId}&limit=50
```

Related CLI docs: [alerts](/docs/cli-alerts).

## Team

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [List team members](/docs/api/account/team/list) | GET | `/websites/{websiteId}/team` | `team:read` | List team members |
| [Invite team member](/docs/api/account/team/invite) | POST | `/websites/{websiteId}/team` | `team:write` + owner role | Invite a team member |
| [Remove team member](/docs/api/account/team/remove) | DELETE | `/websites/{websiteId}/team` | `team:write` + owner role | Remove a team member |

Invite a team member:

```sh
curl -X POST "https://datafa.st/api/v1/admin/websites/YOUR_WEBSITE_ID/team" \
  -H "Authorization: Bearer dft_xxx" \
  -H "Content-Type: application/json" \
  -d '{"email":"member@example.com","role":"viewer"}'
```

Roles are `viewer` and `member`. Team invite and remove actions require the caller to be the website owner.

## Integrations

| Endpoint | Method | Path | Permission | Purpose |
|---|---|---|---|---|
| [Get integrations](/docs/api/account/integrations/retrieve) | GET | `/websites/{websiteId}/integrations` | `settings:read` | Get provider connection status |
| [Connect Stripe](/docs/api/account/integrations/stripe/connect) | POST | `/websites/{websiteId}/integrations/stripe` | `settings:write` | Connect Stripe with `stripeRak` |
| [Disconnect Stripe](/docs/api/account/integrations/stripe/disconnect) | DELETE | `/websites/{websiteId}/integrations/stripe` | `settings:write` | Disconnect Stripe |
| [Connect Lemon Squeezy](/docs/api/account/integrations/lemonsqueezy/connect) | POST | `/websites/{websiteId}/integrations/lemonsqueezy` | `settings:write` | Connect Lemon Squeezy with `lemonsqueezyApiKey` and `lemonsqueezyStoreId` |
| [Disconnect Lemon Squeezy](/docs/api/account/integrations/lemonsqueezy/disconnect) | DELETE | `/websites/{websiteId}/integrations/lemonsqueezy` | `settings:write` | Disconnect Lemon Squeezy |
| [Connect Polar](/docs/api/account/integrations/polar/connect) | POST | `/websites/{websiteId}/integrations/polar` | `settings:write` | Connect Polar with `polarAccessToken` and `polarOrgId` |
| [Disconnect Polar](/docs/api/account/integrations/polar/disconnect) | DELETE | `/websites/{websiteId}/integrations/polar` | `settings:write` | Disconnect Polar |
| [Connect Paddle](/docs/api/account/integrations/paddle/connect) | POST | `/websites/{websiteId}/integrations/paddle` | `settings:write` | Connect Paddle with `paddleApiKey` |
| [Disconnect Paddle](/docs/api/account/integrations/paddle/disconnect) | DELETE | `/websites/{websiteId}/integrations/paddle` | `settings:write` | Disconnect Paddle |
| [Disconnect Shopify](/docs/api/account/integrations/shopify/disconnect) | DELETE | `/websites/{websiteId}/integrations/shopify` | `settings:write` | Disconnect Shopify |
| [Disconnect WooCommerce](/docs/api/account/integrations/woocommerce/disconnect) | DELETE | `/websites/{websiteId}/integrations/woocommerce` | `settings:write` | Disconnect WooCommerce |

Provider credentials are stored by DataFast and never returned by the status endpoint.

## Analytics with account tokens

Account tokens can also call website API endpoints when they include the right permission and `websiteId` query parameter:

```sh
curl "https://datafa.st/api/v1/analytics/timeseries?websiteId=YOUR_WEBSITE_ID&fields=visitors&interval=day" \
  -H "Authorization: Bearer dft_xxx"
```

For website analytics docs, start with [Analytics](/docs/api/website/analytics), [Visitors](/docs/api/website/visitors), or [Funnel analytics](/docs/api/website/analytics/funnel-results).