Documentation
GET /api/editor/
Read editor state and store metrics.
| Request | GET /api/editor/ |
|---|---|
| Authentication | Session cookie required |
| Handler | backend/editor10x.py |
What it does
A prefix route. Everything under `/api/editor/` is served by the editor module; `GET /api/editor/metrics?product_id=<id>&days=<n>` is the one the commerce assistant depends on, returning `status`, `sessions`, `cart`, `checkout` and `paid` counts over the window.
Authentication
Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ff_session | cookie | string | Optional | The session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims. |
product_id | query | string | Optional | The store to read metrics for. |
days | query | integer | Optional | Window length in days. The assistant asks for 14. |
Request
The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.
curl -s -b cookies.txt -c cookies.txt \
"https://flowfinds.ai/api/editor/"const res = await fetch("https://flowfinds.ai/api/editor/", {
method: "GET",
credentials: "include",
});
const data = await res.json();import requests
s = requests.Session()
r = s.get("https://flowfinds.ai/api/editor/")
data = r.json()Recorded example
curl -s -b cookies.txt -c cookies.txt \
"$FLOWFINDS_ORIGIN/api/editor/metrics?product_id=…&days=14"Responses
200 — The editor served the request.
| Field | Type | Description |
|---|---|---|
status | string | `ok` when counts are available. |
sessions | number | Sessions in the window. |
cart | number | Sessions that reached the cart. |
checkout | number | Sessions that reached checkout. |
paid | number | Sessions with a paid browser event. Unverified — the payment ledger is the authority on sales. |
Errors
This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.
Related
GET /api/store— The state of the session's storefront.POST /api/store— Start generating the storefront for the session's product.POST /api/store/publish— Verify and publish the storefront, regenerating it if verification demands.POST /api/intent— Ask the engine what it would change on a surface, and why.POST /api/intent/apply— Apply a proposed intent, regenerating the store.POST /api/intent/order— Override the section the storefront leads with.POST /api/intent/revert— Undo the last applied intent.POST /api/ai/edit— Edit the storefront in natural language.
Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.