/stats/nps

get

https://api.goodays.co/v2/stats/nps

Returns the NPS calculated by Goodays, with the same filters as in the Goodays back office: the score and the number and share of detractors, passives and promoters. Use by, by_context or by_level_category (one at a time) to get one result per group. See NPS - Net Promoter Score.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

enum

The field used to aggregate the metric.

by_context

string

The key from the context used to aggregate the metric.

by_level_category

string

The level category value used to aggregate the metric.

place

string

Filter on a point of sale: Place ID from /places. The External ID is not accepted.

places

string

Filter on several points of sale: Place IDs separated by commas.

level

string

Filter on the points of sale of a level: ID from /levels.

levels

string

Filter on the points of sale of several levels: level IDs separated by commas.

question

string

Filter on a question: question ID from /surveys/{id}.

survey

string

Filter on a survey: ID from /surveys.

nps

string

enum

Filter on the NPS category of the end customer: detractor, passive or promoter.

Allowed:

remark_type

string

enum

Filter on the remark type of the verbatim.

Allowed:

source

string

enum

Filter on the source (collection channel).

begin

string

Start of the period, ISO 8601 date and time, for example 2026-05-01T00:00:00Z. Must be before end. Its timezone is also used to cut days, months, quarters and years with by. See Timezone And Date Management.

end

string

End of the period, ISO 8601 date and time, for example 2026-05-31T23:59:59Z. Must be after begin. See Timezone And Date Management.

Response

200OK