API Reference

Remarks

Suggest Edits

📘

What's that?

A remark is the message left by the End Customer. It can be typed as Idea, Praise, Problem or Question.

The discussion between the Local Manager and the End Customer. after the first comment from the End Customer is typed as a "Message".

👍

Going further

Consult the general Metrics API documentation for more.

How do I get my remarks metrics?

With /stats/remarks:

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

{
    "data": [
        {
            "key": null,
            "description": null,
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        }
    ]
}

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

AttributeDescription
keyDistribution key ID.
descriptionDescription of the distribution key.
countNumber of participations in the selection over the requested period.
IdeaEnd Customer having left a remark typed "Idea".
PraiseEnd Customer having left a remark typed "Praise".
ProblemEnd Customer having left a remark typed "Problem".
QuestionEnd Customer having left a remark typed "Question".
MessageThe discussion between the Local Manager and the End Customer. after the first comment from the End Customer is typed as a "Message".
countNumber of responses for the type of remarks observed over the requested periods for the Idea, Praise, Problem, Question or Message.
percentagePercentage of responses for the type of remarks observed over the requested periods for the Idea, Praise, Problem, Question or Message.

📘

Zoom on "key" and "description" attribute

This attributes are Only filled in when "by", "bycontext" 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 score over a defined period, an establishment...

GET parameters

To calculate a remarks metrics it is possible to combine the following GET parameters:

GET parametersDescription
beginStart date of the calculation period.
Format : YYYY-MM-DDThh:mm:ssZ
See this page for the timezone management.
endEnd date of the calculation period.
Format : YYYY-MM-DDThh:mm:ssZ
See this page for the timezone management.
place Filter on an establishment.
It is necessary to indicate the ID of the establishment from the endpoint /places.
places Filter on an establishment list.
Format : Establishment IDs separated by commas.
level Filter on a level.
It is necessary to indicate the ID of the establishment from the endpoint /levels.
levels Filter on a level list.
Format : Level IDs separated by commas.
surveyfilter 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".
context_Filter on a value of Additional Information.
To construct this parameter you need to concatenate the prefix `contextand one of thekey` attribute returned by the endpoint /configuration._

See the :information-source: block below.
remark_type Filter on remark type : "Idea", "Message", "Praise", "Problem", "Question".
source Filter on source : "critizr", "email", "facebook", "google", "sms", "tripadvisor", "widget", "wifi".
by Group calculations by.
See chapter by.
by_context Group calculations by Additional Information.
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 "context_" parameter

"Additional Information" is additional data attached to a response to give a better understanding about the context.

The list of Additional Information available depends on your Goodays configuration and can be retrieved by the endpoint configuration. The only 'Additional Information" usable with this parameter are the one with the field "use_in_stats" = true.

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

📘

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/remarks 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

Calculate the remarks metrics 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 establishment over the month of May 2020" or By month for one level and a specific source use cases.

By Context

Calculate the remarks metrics for each value of the "Additional Information" passed as a parameter and return a list.

"Additional Information" is additional data attached to a response to give a better understanding about the context.

The list of Additional Information available depends on your Goodays configuration and can be retrieved by the endpoint configuration. The only 'Additional Information" usable with this parameter are the one with the field "use_in_stats" = true.

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

By Level Category

Calculate the remarks metrics 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 remarks metrics 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 establishment 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/remarks? \
   begin=2020-05-01T00:00:00Z \
   &end=2020-05-31T23:59:00Z \
   &by=place' \
--header 'Content-Type: application/json' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "data": [
        {
            "key": "bwdQ661e4Q",
            "description": "VÉLO Chambéry (Chambéry) - velo-chambery",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "bQdPLrmwd9",
            "description": "VÉLO Berlin (Berlin) - velo-berlin",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "My4lvMpK8R",
            "description": "VÉLO London (London) - velo-london",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        }
    ]
}

📘

Zoom on "by" parameter

Here the "by" distributes the calculation by establishment. The attribute "key" contains the ID of the institution and the "description" its name.

For one End Customer

I have to use the following parameters :

  • email

Tips : you can add the parameter "by" with the value "place" to get a distribution of this end-customer's scores by establishment.

curl --location --request GET 'https://api.goodays.co/v2/stats/remarks? \
[email protected]' \
--header 'Content-Type: application/json' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "data": [
        {
            "key": null,
            "description": null,
            "count": 6,
            "Idea": {
                "count": 0,
                "percentage": 0
            },
            "Praise": {
                "count": 1,
                "percentage": 20
            },
            "Problem": {
                "count": 2,
                "percentage": 40
            },
            "Question": {
                "count": 0,
                "percentage": 0
            },
            "Message": {
                "count": 3,
                "percentage": 60
            }
        }
    ]
}

📘

Zoom on "by" parameter

Here there is no "by". The attribute "key" and "description" contains "null".

For one Additional Information

I have to use the following parameters :

  • context_ : "context_service"

Hypothesis: in our configuration we have a "Service" Additional Information with a service key

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

{
    "data": [
        {
            "key": null,
            "description": null,
            "count": 8379,
            "Idea": {
                "count": 771,
                "percentage": 9.201575366988902
            },
            "Message": {
                "count": 0,
                "percentage": null
            },
            "Praise": {
                "count": 4725,
                "percentage": 56.390977443609025
            },
            "Problem": {
                "count": 2596,
                "percentage": 30.98221744838286
            },
            "Question": {
                "count": 287,
                "percentage": 3.4252297410192147
            }
        }
    ]
}

If the value is not known an error is returned:

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

{
    "context value": "Unhandled value vege for parameter context_service"
}

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 your level "South France"

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

{
    "data": [
        {
            "key": "2020-04",
            "description": "2020-04",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "2020-05",
            "description": "2020-05",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "2020-06",
            "description": "2020-06",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        }
    ]
}

📘

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 : "price"

Hypothesis: additional information exists in your configuration and is present in ever response. 

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

{
    "data": [
        {
            "key": "3Q54E78yD9",
            "description": "Entre 500 et 1000€",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "lZmxo9dj6G",
            "description": "Entre 200 et 500€",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "NEexq5xYzW",
            "description": "Supérieur à 1000€",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        }
    ]
}

📘

Zoom on "by_context" parameter

Here the "by_context" distributes the calculation by additional information "price". The attribute "key" contains the ID of the additional information 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" corresponds to your regions.

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

{
    "data": [
        {
            "key": "LAEd7rX893",
            "description": "Bretagne",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "ELxjpqAdKg",
            "description": "Berlin",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        },
        {
            "key": "OKQ4eXAdeW",
            "description": "Provence-Alpes-Côte d'Azur",
            "count": 150397,
            "Idea": {
                "count": 36094,
                "percentage": 23.999148919193868
            },
            "Praise": {
                "count": 80626,
                "percentage": 53.60878209006829
            },
            "Problem": {
                "count": 28532,
                "percentage": 18.971123094210657
            },
            "Question": {
                "count": 4734,
                "percentage": 3.147669168932891
            },
            "Message": {
                "count": 411,
                "percentage": 0.27327672759430044
            }
        }
    ]
}

📘

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.

Updated 7 months ago