API Introduction

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 <code>Authorization</code> header using the Bearer scheme. Substitute <code>YOUR_API_KEY</code> with the key you created.

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:

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

Error responses return the relevant HTTP status code (4xx or 5xx) with a body like:

{
  "status": "error",
  "error": {
    "code": "HTTP_STATUS_CODE",
    "message": "A descriptive error message"
  }
}