api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/metadataFetch the configuration metadata for your website.
Bearer Token (workspace token or website API key)
Workspace Tokens Need a Website Selector
Workspace API tokens can access every website in the workspace. Pass eitherwebsiteId or domain so Flowsery knows which website to query or mutate. Website API keys are already scoped to one website, so the selector can be omitted.Website Selector
| Parameter | Type | Description |
|---|---|---|
websiteId | string | Website ID to use with a workspace API token. Omit when authenticating with a website API key. |
domain | string | Website domain to use with a workspace API token when websiteId is not provided. Omit when authenticating with a website API key. |
Response Fields
Response Fields
| Parameter | Type | Description |
|---|---|---|
domain | string | The website's domain. |
timezone | string | IANA timezone identifier for the site (e.g., "America/New_York", "UTC"). |
logo | string | null | URL of the custom site logo, or null when none is set. |
kpiColorScheme | string | Color scheme used for KPI visualizations. Possible values: red, orange, yellow, green, purple, pink, gray, blue, teal, indigo. |
kpi | string | null | The custom goal/event name designated as the key performance indicator for this site. |
currency | string | Currency code (e.g., "USD", "EUR", "GBP"). |
Example Request (Curl)
curl --request GET \
--url https://analytics.flowsery.com/analytics/api/v1/metadata \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"domain": "example.com",
"timezone": "America/New_York",
"logo": "https://d1aebdcemlt4l7.cloudfront.net/website-logos/xK9mPq2bR7nYwJ3vL5tA.png",
"kpiColorScheme": "orange",
"kpi": "signup",
"currency": "USD"
}
]
}