canonical: https://jentic.com/apis/flowsery.com/flowsery

# Flowsery Analytics Public API

The Flowsery Analytics Public API reads web analytics and records conversion events for a website. It returns traffic, revenue, and engagement for any date range and breaks visitors down by page, referrer, channel, campaign, country, device, browser, or operating system, and it can pull a single visitor's full activity timeline. It counts the visitors active right now and maps their locations, records goals and payments from your own backend, and lists AI-detected issues so a team can act on anomalies in the data.

## For AI agents

Read web analytics for a website and record conversion events: traffic, revenue, and engagement by date range, dimension breakdowns, realtime counts, single-visitor timelines, and goal and payment recording.

## Scope

Does not handle ad campaign management, tag deployment, or session recording. Use for reading web analytics and recording conversion events only.

## Capabilities

- Read headline traffic, revenue, and engagement metrics for a date range
- Break visitors down by page, referrer, channel, campaign, country, device, browser, or OS
- Pull metrics bucketed over time as a time series
- Count the visitors active right now and map their locations
- Record a goal completion or a payment from your own backend
- Read a single visitor's full activity timeline
- List AI-detected issues and update their status

## Use cases

### Agent analytics reporting

An AI agent connected through Jentic answers a question about a site's performance by reading the headline metrics for a date range and breaking visitors down by channel or page, so a stakeholder gets a live answer without the developer wiring the bearer auth or paging each breakdown by hand.

Example prompt: Read headline metrics for last month and break visitors down by acquisition channel for a summary

### Server-side conversion tracking

A backend records goals and payments directly through the events endpoints when a sale or renewal happens, so revenue and conversions are measured from the source of truth rather than a browser tag, and a refund can be recorded or a mis-fired goal deleted.

Example prompt: Record a payment and a goal completion from the backend and delete a goal that fired in error

### Realtime monitoring and issue triage

An operations assistant counts the visitors active right now and reviews the AI-detected issues, updating an issue's status as it is handled, so a spike or an anomaly is caught and tracked from live data instead of a next-day report.

Example prompt: Count active visitors, open the current AI-detected issues, and update one issue's status to in progress

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/overview` | Headline metrics for a date range |
| GET | `/timeseries` | Metrics bucketed over time |
| GET | `/pages` | Break down visitors by page path |
| GET | `/breakdown` | Break down visitors by any supported dimension |
| GET | `/realtime` | Count visitors active right now |
| POST | `/goals` | Record a goal completion |
| POST | `/payments` | Record a payment, renewal, or refund |
| GET | `/visitors/{visitorId}` | A visitor's profile and activity timeline |

## Key resources

- **Reports** — Read headline metrics and metrics bucketed over time
- **Breakdowns** — Break visitors down by page, referrer, channel, country, device, and more
- **Events** — Record and delete goals and payments from your backend
- **Visitors** — Read a single visitor's profile and activity timeline
- **Issues** — List AI-detected issues and update their status

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 68 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 49 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 81 / 100
- **View full report:** https://jentic.com/apis/flowsery.com/flowsery/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Flowsery by hand means handling its bearer auth, choosing between a website key and a workspace token, and passing the right website selector on each call yourself. Through Jentic you install once, import Flowsery from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Flowsery takes the website selector as a parameter, not a path segment, so rules bound which operations your agent may call, not which website. Limit it to the read operations, such as metrics and breakdowns, so recording and deleting goals and payments stay out of reach unless you add those operations.
- **Credential handling:** Your Flowsery token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get web analytics for a date range' or 'break down visitors by channel', and Jentic returns the matching Flowsery operation with its input schema so the agent calls the right endpoint without reading the reference docs.

## Related APIs

- **Plausible** — Privacy-focused web analytics with a similar metrics-and-breakdowns model
- **Mixpanel** — Event-based product analytics rather than site-level traffic reporting
- **Amplitude** — Product-analytics platform that can sit alongside site-level reporting

## FAQ

### What authentication does the Flowsery Analytics API use?

The Flowsery Analytics API authenticates with a bearer token in the Authorization header, per its OpenAPI spec: a website API key scoped to one website, or a workspace token that spans every website in the account. Through Jentic the token is stored encrypted by your own Jentic One instance and injected at call time, so it never lands in the agent's context.

### Is there a Flowsery MCP server?

You don't need an MCP server to give your agent Flowsery. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls the metrics, breakdown, and event operations on demand, without a separate server's tool definitions loaded into its context.

### Can I limit what my agent is allowed to do with the Flowsery Analytics API?

Yes. Flowsery takes the website selector as a parameter rather than a path segment, so a rule bounds which operations the agent may call. Allow only the read operations, such as reading metrics and breakdowns, so the agent can report analytics but cannot record or delete goals and payments, with every call logged.

### Can I record conversions from my backend with the Flowsery Analytics API?

Yes. The goals endpoint records a goal completion and the payments endpoint records a payment, renewal, or refund from your own backend, and matching delete operations remove entries recorded in error.

### What are the rate limits for the Flowsery Analytics API?

The OpenAPI spec does not specify rate limits. Check the vendor documentation at https://flowsery.com for current limits before pulling large date ranges or many breakdowns.

### How do I read a site's metrics through Jentic?

Search Jentic for 'get web analytics for a date range', which returns the Flowsery overview operation with its input schema, then pass the date range and read the headline metrics back. To run it on your own infrastructure, install Jentic One from its GitHub repo.
