Source: https://datafa.st/docs/api-metadata
Markdown source: https://datafa.st/docs/api-metadata.md
Description: Get website configuration metadata including domain, timezone, name, logo, KPI color scheme, KPI goal, and currency.

# Get website metadata

`GET https://datafa.st/api/v1/analytics/metadata`

Retrieve website configuration metadata for your site. Requires [Bearer Token](/docs/api-introduction) authentication.

## Response

**Success (200 OK):** Returns website configuration metadata

```json
{
  "status": "success",
  "data": [
    {
      "domain": "example.com",
      "timezone": "America/New_York",
      "name": "My Awesome Website",
      "logo": "https://d1aebdcemlt4l7.cloudfront.net/website-logos/xK9mPq2bR7nYwJ3vL5tA.png",
      "kpiColorScheme": "orange",
      "kpi": "signup",
      "currency": "USD"
    }
  ]
}
```

### Response fields

- **`domain`** (string): The website domain
- **`timezone`** (string): Website timezone in IANA timezone format (e.g., "America/New_York", "UTC")
- **`name`** (string): Custom website name
- **`logo`** (string | null): Custom website logo URL, or null if not set. You can upload a custom logo in your [website settings](https://datafa.st/dashboard) under "Website nickname"
- **`kpiColorScheme`** (string): Color scheme for KPI visualization. Possible values: "red", "orange", "yellow", "green", "purple", "pink", "gray", "blue", "teal", "indigo"
- **`kpi`** (string | null): Custom goal/event name set as the key performance indicator for this website
- **`currency`** (string): Currency code (e.g., "USD", "EUR", "GBP")

## Errors

- **401 Unauthorized:** Missing or invalid API key
- **404 Not Found:** Website not found
- **500 Internal Server Error:** Server-side issue

## Query parameters

### Optional parameters

- **`fields`** (string): Comma-separated list of fields to return. Valid fields: `domain`, `timezone`, `name`, `logo`, `kpiColorScheme`, `kpi`, `currency`. If not specified, all fields are returned.

- **`startAt`** (string): Start date/time in ISO 8601 format (e.g., 2024-01-01T00:00:00Z or 2024-01-01). If omitted, returns all-time data

- **`endAt`** (string): End date/time in ISO 8601 format. Must be provided together with `startAt` if using custom date range

- **`timezone`** (string): Timezone for data aggregation (e.g., UTC, America/New_York, Europe/Amsterdam). Defaults to your website's timezone if not specified

- **`limit`** (number): Maximum number of results to return (1-1000, default: 100)

- **`offset`** (number): Number of results to skip for pagination (default: 0)

## Code examples

### Example request (Node.js/Express)

```javascript
const response = await fetch(
  "https://datafa.st/api/v1/analytics/metadata",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${DATAFAST_API_KEY}`,
      "Content-Type": "application/json",
    },
  }
);

const result = await response.json();
console.log(result);
```

### Success response (200 OK)

```json
{
  "status": "success",
  "data": [
    {
      "domain": "example.com",
      "timezone": "America/New_York",
      "name": "My Awesome Website",
      "logo": "https://d1aebdcemlt4l7.cloudfront.net/website-logos/xK9mPq2bR7nYwJ3vL5tA.png",
      "kpiColorScheme": "orange",
      "kpi": "signup",
      "currency": "USD"
    }
  ]
}
```