Inbox
What's that?
The Inbox is where a Goodays user receives all the feedback 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 |
Total items awaiting processing?
To get the total number of items waiting to be processed, the two attributes
alert
andawaiting_reply
must be added together.
Add some filters
It is possible to add GET parameters to refine the calculation of the score over a Goodays user perimeter or an establishment.
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 an establishment. Enter your establishment code directly here |
level | Filter on a level. It is necessary to indicate the ID of the establishment from the endpoint /levels. |
pro_user | Filter on the perimeter of a Goodays 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 Goodays 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
}
For one establishment
I have to use the following parameters :
- place
curl --location --request GET 'https://api.goodays.co/v2/dashboard? \
place=ABC123' \
--header 'Authorization: a6d5e8f3917f5220e3d4ce247e7fc3d29a13f244'
{
"pending_alert": 2,
"pending_reply": 10
}
Updated 10 months ago