api-reference

1. Create an API key

Head to your Site Settings > API tab within the Flowsery Analytics dashboard. Generate a fresh API key. Copy it right away since it will not be displayed again. Treat your API keys like passwords -- store them securely and never expose them in client-side code or public repositories. All keys use the <code>flow_</code> prefix (e.g. <code>flow_sk_live_abc123</code>).

2. Authenticate your requests

Every API call must include the Authorization header using the Bearer scheme. API keys must start with the flow_ prefix.

Authorization header
Authorization: Bearer YOUR_API_KEY

3. Start making requests

The base URL for all v1 endpoints is: <code>https://analytics.flowsery.com/api/v1/</code>

Response format

Successful responses return a 200 OK status with a body structured as:

Success response
{
  "status": "success",
  "data": { ... }
}

Errors use the normal NestJS HTTP error response shape.

Error response
{
  "message": "Unauthorized",
  "statusCode": 401
}

Standard error codes

<strong>400 Bad Request</strong> -- The input is invalid or required parameters are missing.<br /><strong>401 Unauthorized</strong> -- The API key is missing, invalid, or does not start with flow_.<br /><strong>404 Not Found</strong> -- The requested resource does not exist.<br /><strong>500 Internal Server Error</strong> -- An unexpected issue occurred on the server.
Example request (curl)
curl --request GET \
  --url https://analytics.flowsery.com/api/v1/overview \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890
    }
  ]
}