📘
What's that?
A retained customer is an end customer who has expressed dissatisfaction and has been identified as "at risk". After the reply of a pro user, this end customer indicated that they were satisfied with the treatment of their dissatisfaction and considered returning to the point of sale. The pro user's action thus prevented this end customer from churning.

👍
Going further
Consult the general Metrics API documentation for more.

How do I get my Retained Customers metrics?

With /stats/stats_retained_customers_list:

curl --location --request GET 'https://api.goodays.co/v2/stats/retained_customers' \
--header 'Content-Type: application/json' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "data": [
        {
            "key": null,
            "description": null,
            "retained_customers_count": 80,
            "retained_customers_percentage": 66.66666666666666,
            "customers_responding_count": 120
        }
    ]
}

By default the calculation of the score is done "since always".
And the return will always contain:

Attribute	Description
key	Distribution key ID.
description	Description of the distribution key.
retained_customers_count	Total number of end customers who are satisfied with the pro user's reply and planned to return to the point of sale.
retained_customers_percentage	Percentage of total number of end customers who are satisfied with the pro user's reply and planned to return to the point of sale.
customers_responding_count	Total number of end customers responding to the question about coming back to the point of sale

📘
Zoom on "key" and "description" attribute
This attributes are only filled in when "by", "by_context" or "by_level_category" is used.
Otherwise they have the value null.

Add some filters

It is possible to add GET parameters to refine the calculation of the dissatisfaction results over a defined period, a point of sale...

GET parameters

To filter the Retained Customers results, it is possible to combine the following GET parameters:

GET parameters	Description
begin	Start date of the calculation period. Format : YYYY-MM-DDThh:mm:ssZ See this page for the timezone management.
end	End date of the calculation period. Format : YYYY-MM-DDThh:mm:ssZ See this page for the timezone management.
place	Filter on a point of sale. It is necessary to indicate the Place ID from the endpoint /places
places	Filter on a list of points of sale. Format : Place IDs separated by commas
level	Filter on a level. It is necessary to indicate the ID of the level from the endpoint /levels
levels	Filter on a level list. Format : Level IDs separated by commas
survey	filter on a survey. It is necessary to indicate the ID of the question from the endpoint/surveys
question	Filter on a question. It is necessary to indicate the ID of the question from the endpoint/surveys
nps	Filter on nps category : "detractor", "passive", "promoter".
remark_type	Filter on remark type : "Idea", "Message", "Praise", "Problem", "Question".
source	Filter on source : "email", "facebook", "google", "sms", "tripadvisor", "widget", "wifi".
by	Group calculations by. See chapter by
by_context	Group calculations by custom parameter. See chapter by Context
by_level_category	Group calculations by level category. See chapter by Level Category

📘
Get an updated list of values for the "source" parameter
The examples listed for the "source" parameter are not exhaustive. To obtain an exhaustive list, the endpoint /stats/retained-customers must be called by indicating an unexpected value. In return the error message will list all possible values.

Group calculations

The three "by" parameters allow you to retrieve a list of results aggregated according to the value selected in the input.

📘
Combine the "by" or not combine the "by" ?
You can combine several other GET parameters with a "by" but you can not combine the filters "by", "by_context" and "by_level_category" in a single request. Only one aggregation parameter is allowed.

Here are the 3 possibilities :

By

Refine the calculation of the Retained Customers results by grouping elements and return a list.

The distribution of the calculation can be by : "day", "month", "nps_category", "place", "quarter", "remark_type", "source", "survey", "year".

See "By point of sale over the month of May 2020" or By month for one level and a specific source use cases.

By Context

Refine the calculation of the Retained Customers results for each value of the custom parameter passed as a parameter and returns a list.

A custom parameter is additional data attached to a participation to describe its context (order date, purchase amount, advisor...).

The list of your custom parameters depends on your Goodays configuration and can be retrieved by the endpoint configuration. Only the custom parameters with the field "use_in_stats" = true can be used with this parameter.

See "By context of the purchase amount" use case.

By Level Category

Refine the calculation of the Retained Customers results by level category and return a list.

The categories represent your hierarchical or geographical organization depending on your Goodays configuration.

From these categories, you can calculate the Retained Customers results distributed by region, business unit, brand, etc.

The category ID to be used is returned by the endpoint /levels, in the "category_id" attribute.

See "By level category" use case.

Use cases

Here are some examples to show you the possibilities of this endpoint. This is obviously not exhaustive, it's up to you to have fun to find the right parameter arrangements :)

By point of sale over the month of May 2020

I have to use the following parameters :

begin : the first date of the month of May
end : the last date of the month of May
by : group calculation by "place"

curl --location --request GET 'https://api.goodays.co/v2/stats/retained-customers? \
   begin=2020-05-01T00:00:00Z \
   &end=2020-05-31T23:59:00Z \
   &by=place' \
--header 'Content-Type: application/json' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "data": [
        {
            "key": "mj8133D64R",
            "description": "VÉLO Annecy (Annecy) - velo-annecy",
            "retained_customers_count": 2,
            "retained_customers_percentage": 50.0,
            "customers_responding_count": 4
        },
        {
            "key": "qz4RZZM94r",
            "description": "VÉLO Aix-en-Provence (Aix-en-Provence) - velo-aix-en-provence",
            "retained_customers_count": 2,
            "retained_customers_percentage": 50.0,
            "customers_responding_count": 4
        }
    ]
}

📘
Zoom on "by" parameter
Here the "by" distributes the calculation by point of sale. The attribute "key" contains the Place ID of the point of sale and the "description" its name.

By month for one level and a specific source

I have to use the following parameters :

source : "email"
level : level ID
by : "month"

Hypothesis: in our configuration the level ID "Yqxzp5Ad2J" corresponds to our level "South France"

curl --location --request GET 'https://api.goodays.co/v2/stats/retained_customers? \
source=email \
&level=Yqxzp5Ad2J \
&by=month' \
--header 'Content-Type: application/json' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "data": [
        {
            "key": "2021-07",
            "description": "2021-07",
            "retained_customers_count": 4,
            "retained_customers_percentage": 36.36363636363637,
            "customers_responding_count": 11
        },
        {
            "key": "2021-08",
            "description": "2021-08",
            "retained_customers_count": 6,
            "retained_customers_percentage": 75.0,
            "customers_responding_count": 8
        },
        {
            "key": "2021-09",
            "description": "2021-09",
            "retained_customers_count": 8,
            "retained_customers_percentage": 80.0,
            "customers_responding_count": 10
        },
        {
            "key": "2021-10",
            "description": "2021-10",
            "retained_customers_count": 7,
            "retained_customers_percentage": 46.666666666666664,
            "customers_responding_count": 15
        },
        {
            "key": "2021-11",
            "description": "2021-11",
            "retained_customers_count": 3,
            "retained_customers_percentage": 50.0,
            "customers_responding_count": 6
        }
    ]
}

📘
Zoom on "by" parameter
The attributes "key" and "description" both contain the relevant year and month.

By context of the purchase amount

I have to use the following parameters :

by_context : "advisor"

Hypothesis: the custom parameter exists in your configuration and is present in every participation.

curl --location --request GET 'https://api.goodays.co/v2/stats/retained-customers?by_context=advisor' \
--header 'Content-Type: application/json' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "data": [
        {
            "key": "ryLdLpdj1e",
            "description": "Nizar",
            "retained_customers_count": 60,
            "retained_customers_percentage": 61.855670103092784,
            "customers_responding_count": 97
        },
        {
            "key": "ap4MPA1wd2",
            "description": "Jeanne",
            "retained_customers_count": 12,
            "retained_customers_percentage": 92.3076923076923,
            "customers_responding_count": 13
        },
        {
            "key": "BQe4Zoxprb",
            "description": "Clémence",
            "retained_customers_count": 1,
            "retained_customers_percentage": 100.0,
            "customers_responding_count": 1
        }
    ]
}

📘
Zoom on "by_context" parameter
Here the "by_context" distributes the calculation by custom parameter "price". The attribute "key" contains the ID of the custom parameter value and the "description" its name.

By level category

I have to use the following parameters :

by_level_category : "2"

_Hypothesis: in our configuration the level category "2" refers to our level "_regions*".

curl --location --request GET 'https://api.goodays.co/v2/stats/retained-customers?by_level_category=5' \
--header 'Content-Type: application/json' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "data": [
        {
            "key": "ryLdLpdj1e",
            "description": "France",
            "retained_customers_count": 60,
            "retained_customers_percentage": 61.855670103092784,
            "customers_responding_count": 97
        },
        {
            "key": "ap4MPA1wd2",
            "description": "Germany",
            "retained_customers_count": 12,
            "retained_customers_percentage": 92.3076923076923,
            "customers_responding_count": 13
        },
        {
            "key": "BQe4Zoxprb",
            "description": "United Kingdom",
            "retained_customers_count": 1,
            "retained_customers_percentage": 100.0,
            "customers_responding_count": 1
        }
    ]
}

📘
Zoom on "by_level_category" parameter
Here the "by_level_category" distributes the calculation by level category. The attribute "key" contains the ID of the level and the "description" the level name.