Consolidated customer satisfaction report — NPS, CSAT, the ratings and
reviews customers leave — the answer to "what's our NPS", "satisfaction per
store", "how are customers rating us", "which stores score best", in a
single call. No need to page the feedback reviews store by store. (For the
raw responses one by one, use the feedback review list.)
Returns the overall total and a per-store breakdown, with responses,
avgRating, and how many reviews came in without a salesperson
(withoutSalesperson, typically e-commerce).
type=csat (1-5 scale): satisfied (4-5), neutral (3),
unsatisfied (1-2) and satisfactionRate = satisfied / responses (a ratio,
0.967 = 96.7%). The NPS fields are not emitted for CSAT — a 1-5 rating is
never a "detractor" on the 0-10 band, so an NPS score there is meaningless.
Try-it values populated from environment ACME (Demo)
Send your user token in the x-guper-authorization header.
Headers
Name
Type
Description
x-guper-authorization
*
string
User token issued by Guper.
Content-Type
*
string
Always `application/json` for endpoints that accept a JSON body.
Query parameters
Name
Type
Description
days
integer
Window: the last N days (1-730). Default 90. Ignored when dateStart/dateEnd are given.
dateStart
string
Start date (YYYY-MM-DD). Use together with dateEnd for an explicit window.
dateEnd
string
End date (YYYY-MM-DD), inclusive.
type
string
Which survey to report. Default `nps`. `nps` returns the 0-10 bucket
(`promoters`/`passives`/`detractors`/`nps`); `csat` returns the 1-5 one
(`satisfied`/`neutral`/`unsatisfied`/`satisfactionRate`). `avgRating` and
`responses` come with both.
store
integer
Restrict to a single store id.
groupBy
string
Break the numbers down by `store` (default), `day` or `month`, or a comma
list combining `store` with `day`/`month` (e.g. `month,store`). `day` and
`month` cannot be combined. Each breakdown comes under `rows`; `total` is
always the overall. When `groupBy=store`, `rows` is also aliased as
`byStore` for compatibility. The day/month is cut in the **org timezone**
(feedback timestamps are stored in BRT and converted).
**Campaign and channel are not here** — feedback carries no campaign,
only `orderId`; for "NPS by campaign" pass the campaign's orders in
`order[]`.
client[]
array
Restrict to a cohort of client (person) ids. This is how you cross
satisfaction with behavior: get the cohort elsewhere (e.g. the clients who
redeemed cashback, from loyalty) and pass it here to read **that cohort's
NPS/CSAT** — then compare with the overall. Comma list or array; up to 5000.
order[]
array
Restrict to a cohort of order ids — e.g. the orders attributed to a
campaign (from the order side), to read the NPS/CSAT of that campaign's
buyers. Comma list or array; up to 5000.