📘
What's that?
The Inbox is where a pro user receives all the participations from end customers to process.
The elements to be processed are distinguished into two attributes:

dissatisfaction alerts

messages

How do I get my inbox metrics?

With /dashboard:

curl --location --request GET 'https://api.goodays.co/v2/dashboard' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "pending_alert": 1,
    "pending_reply": 2
}

The return will always contain:

Attribute	Description
pending_alert	Number of dissatisfaction alerts pending
pending_reply	Number of verbatims awaiting processing
pending_chat	Number of active chat conversations waiting for an answer from your teams. Only returned if the chat feature is enabled on your account. Filtered by `place` and `level`, not by `pro_user`.

📘
Total items awaiting processing?
To get the total number of items waiting to be processed, the attributes pending_alert and pending_reply must be added together (and pending_chat, if the chat feature is enabled on your account).

Add some filters

It is possible to add GET parameters to refine the calculation of the score over a pro user perimeter or a point of sale.

GET parameters

To retrieve the number of items waiting to be processed it is possible to combine the following GET parameters:

GET parameters	Description
place	Filter on a point of sale. Indicate the Place ID from the endpoint /places, or your external ID.
level	Filter on a level. It is necessary to indicate the ID of the level from the endpoint /levels.
pro_user	Filter on the perimeter of a pro user. Format : email url encoded Ex: [email protected] will become yul.brenner%40coolrunnings.com

Use cases

Here are some examples to show you the possibilities of this endpoint.

For one pro user

I have to use the following parameters :

pro_user

curl --location --request GET 'https://api.goodays.co/v2/dashboard? \
	pro_user=yul.brenner%40coolrunnings.com' \
--header 'Authorization: 1234abcd1234abcd1234abcd1234abcd'

{
    "pending_alert": 0,
    "pending_reply": 3
}