Glossary
The words we use across the Goodays API documentation, and the older names you may still find.
This glossary gives one reference name per notion. It uses the same words as the developer documentation glossary. Older pages, attributes and parameters may still use another name: they are listed in the Also called column so you can match them. The Technical name column gives the name used by the API.
Your organization
| Term | Definition | Also called | Technical name |
|---|---|---|---|
| Client | The company that subscribed to Goodays. A client owns one or more universes and all their points of sale. | customer (name used inside some Goodays tools and URLs; in documentation always say client) | |
| Universe | One of your brands, as set up in Goodays, with its own graphic charter: logo, colors, texts. Each point of sale belongs to one universe. For example, a client that runs two restaurant brands has two universes. | brand, banner, enseigne | universe, /universes |
| Pro user | A person from the client's team who uses the Goodays back office to read participations, reply and follow statistics. Each pro user has access to a set of points of sale (their perimeter). | user, Goodays user, back office user, local manager, manager | /users, pro_user (filter), user (in action payloads: see The user field) |
| API token | Secret credential sent in the Authorization header of every API request. It is attached to a pro user: the API only returns the data of the points of sale this pro user has access to. Never expose it in a web page. | access token, API key | Authorization header |
| Goodays project contact | The person at Goodays who follows your project and gives you your identifiers and access. | account manager, Goodays team, Goodays contact, Goodays technical contact, technical referent | |
| Goodays back office | The Goodays web application where pro users read and process participations and follow statistics. | Back Office, interface, platform | app.goodays.co |
Points of sale and organization
| Term | Definition | Also called | Technical name |
|---|---|---|---|
| Point of sale | Any place where Goodays collects feedback: shop, restaurant, agency, mall, website... Each point of sale belongs to one universe. | place, establishment, store, shop, location, POS, agency | place, /places |
| Place ID | Identifier generated by Goodays for a point of sale (the External ID is yours, the Place ID is Goodays'), for example EFGH5678. It is the id returned by /places and is accepted by every endpoint. | Goodays ID, establishment ID | id on a place object, place (filter and payload) |
| External ID | Your own code for a point of sale, as used in your information system (SAP code, store code...), for example ABQ-001. It is set by you and unique per client. The place filter and payload field of the responses, solicitations and dashboard endpoints accept it instead of the Place ID; the Metrics API (stats) endpoints only accept the Place ID. | partner ID, POS ID, store code, establishment code | partner_id (a historical name: it has nothing to do with Goodays partners), external_id |
| Level | A group of points of sale. A grouping can be geographical (a region), hierarchical (a business unit) or logical (points of sale sharing a delivery area). A point of sale can belong to several levels. | brand level, group | level, /levels |
| Level category | The type of a level, set up in your Goodays configuration: region, business unit, brand... Used to aggregate metrics by level of the same category. | category_id, by_level_category |
Feedback
| Term | Definition | Also called | Technical name |
|---|---|---|---|
| End customer | The customer of a client, who gives feedback about a point of sale. | customer, respondent, consumer, user (API field) | user (in a participation: see The user field) |
| Survey | Set of questions submitted to end customers, configured in Goodays. See Survey question types. | questionnaire | survey, /surveys |
| Solicitation | An email or SMS sent to an end customer to invite them to answer a survey, usually right after an interaction (purchase, delivery, visit...), while the experience is still recent. | invitation, sending | solicitation, /solicitations |
| Participation | Everything one end customer submits at once: survey answers, a rating and/or a verbatim, whatever the channel (email, SMS, QR code, website, Google...). It is the base unit of data in Goodays. In this documentation, response only refers to the API object and endpoints. | response (API), feedback, entry, submission, return | response, /responses |
| Source | The channel through which a participation was collected: email, SMS, widget, Google... | collection channel | source |
| Custom parameter | Additional data sent with a participation or a solicitation to describe its context, for example an order date, a purchase amount or a CRM ID. The list of your custom parameters, and which ones are required, is returned by /configuration. | additional information, context, extra data | context (in a participation), custom_parameters (in /configuration), by_context |
| Rating | The score an end customer gives to a question of a survey, for example from 1 to 5 stars or from 0 to 10 for the NPS. | note, mark | value in the answers of a participation |
| Verbatim | The free text written by an end customer in a participation. | comment, message, remark | message |
| Remark type | The category of a verbatim: Idea, Praise, Problem or Question. Message is used for the exchanges that follow the first verbatim, and for external reviews that are not typed. | remark | remark_type, type in message |
| Review | A participation published for the public. Reviews collected from Google are called Google reviews. | public review, user-generated content (UGC) | |
| Score | An indicator calculated from many ratings over a period, such as the Customer Satisfaction score, the NPS, the CES, the Customer Relationship score or the Google Score. See the Metrics API. | average rating, note, KPI | /stats endpoints |
| Dissatisfaction alert | Raised on a participation when the end customer gives a rating equal to or lower than the alert limit of a question, or leaves a verbatim of type Problem. A pro user must process it. | alert | alert_triggered, alert_limit |
Processing participations
| Term | Definition | Also called | Technical name |
|---|---|---|---|
| Reply | The answer a pro user writes to an end customer about their participation. | answer, response | reply, /responses/{id}/reply |
| Private message | A message exchanged after the first reply, between the end customer and the pro users. It is visible only to them. | message | attached_messages, /responses/{id}/message, message event |
| Thread | The conversation made of a participation, its reply and the private messages that follow. Its state is open, closed or spam. | conversation | thread, state |
| Delegation | A pro user hands a participation over to another point of sale, usually Customer Service, which then processes it. | ask for help | delegated_to, delegated event |
| Customer Service | A point of sale set up for a remote customer service team, which processes the participations delegated to it, possibly from its own tool through the Converse API. | remote Customer Service | |
| Event | A notification sent by Goodays to your webhook URL when a participation is received, a private message arrives or a participation is delegated. | webhook, hook | event_type, /events |
The user field
user fieldThe user field does not designate the same person everywhere in the API:
| Where | user means | Content |
|---|---|---|
| A participation you read: /responses, webhook events | The end customer | email, first_name, last_name, opt_in |
| A participation you send: /responses/collect | The end customer | email, first_name, last_name, phone, crm_id |
An action on a participation: /reply, /message, /call, /close, /spam | The pro user who performs the action | The ID of a pro user from /users. Optional: when it is missing, the action is attributed to the pro user of the API token. |
/users, /places/{id}/users, the pro_user filter | A pro user |
The same goes for the email filter: on /responses it filters on the end customer's email, on /users it filters on the pro user's email.
Updated 8 days ago
Did this page help you?