← Back to overview
Lists all companies that have enabled your integration in AreTheyHappy
Possible response codes
- 200
- Success
- 401
- Access Denied
- 403
- Access Forbidden
- 404
- Not found
Example response
[
{
"id": "24050",
"name": "Acme Corp"
}
]This document contains an overview of all methods/models/error codes applicable to the 1.2 version of the AreTheyHappy public REST API
An overview of the methods available in this version of the API
Lists all companies that have enabled your integration in AreTheyHappy
[
{
"id": "24050",
"name": "Acme Corp"
}
]Retrieves a single company by its id
Id of the company
Type: integer
{
"id": "24050",
"name": "Acme Corp"
}Lists all locations for a single company
Id of the company
Type: integer
[
{
"id": "120590",
"name": "Acme Corp - HQ",
"has_integrations": true,
"contact_details": {
"phone": "+32 010 23 45 67",
"website": "example.com",
"email": "[email protected]"
},
"address_details": {
"street": "Kortrijksesteenweg 1070",
"city": "Gent",
"country": "BE",
"zip": "9000",
"lat": 51.031326,
"lng": 3.708748
}
}
]Retrieves a single location by its id on a company by its id
Id of the company
Type: integer
Id of the location
Type: integer
{
"id": "120590",
"name": "Acme Corp - HQ",
"has_integrations": true,
"contact_details": {
"phone": "+32 010 23 45 67",
"website": "example.com",
"email": "[email protected]"
},
"address_details": {
"street": "Kortrijksesteenweg 1070",
"city": "Gent",
"country": "BE",
"zip": "9000",
"lat": 51.031326,
"lng": 3.708748
}
}Retrieves the nps evolution for a company by its id on a range of -100 to 100
Id of the company
Type: integer
Group the result set
Type: string Default: day Enum: day,week,month
Start date, can't be older than 1 year
Type: string Format: YYYY-MM-DD Default: 1 month ago Example: 2019-08-01
End date, can't be today, tomorrow or before start
Type: string Format: YYYY-MM-DD Default: yesterday Example: 2019-08-15
Switch between cumulative and average NPS
Type: string Default: cum Enum: cum,avg
Comma delimited string of location ids for retrieving aggregate average/cumulative NPS for groups of locations
Type: string
[
{
"val": "52.24",
"date": "2019-02-05"
}
]Retrieves the nps evolution for a location on a company by the location_id and company_id on a range of -100 to 100
Id of the company
Type: integer
Id of the location
Type: integer
Group the result set
Type: string Default: day Enum: day,week,month
Start date, can't be older than 1 year
Type: string Format: YYYY-MM-DD Default: 1 month ago Example: 2019-08-01
End date, can't be today, tomorrow or before start
Type: string Format: YYYY-MM-DD Default: yesterday Example: 2019-08-15
Switch between cumulative and average NPS
Type: string Default: cum Enum: cum,avg
[
{
"val": "52.24",
"date": "2019-02-05"
}
]Retrieves the score evolution for a company by its id on a range of 0 to 5
Id of the company
Type: integer
Group the result set
Type: string Default: day Enum: day,week,month
Start date, can't be older than 1 year
Type: string Format: YYYY-MM-DD Default: 1 month ago Example: 2019-08-01
End date, can't be today, tomorrow or before start
Type: string Format: YYYY-MM-DD Default: yesterday Example: 2019-08-15
Switch between cumulative and average score
Type: string Default: cum Enum: cum,avg
Comma delimited string of location ids for retrieving aggregate average/cumulative score for groups of locations
Type: string
[
{
"val": "4.309",
"date": "2019-02-05"
}
]Retrieves the score evolution for a location on a company by the location_id and company_id on a range of 0 to 5
Id of the company
Type: integer
Id of the location
Type: integer
Group the result set
Type: string Default: day Enum: day,week,month
Start date, can't be older than 1 year
Type: string Format: YYYY-MM-DD Default: 1 month ago Example: 2019-08-01
End date, can't be today, tomorrow or before start
Type: string Format: YYYY-MM-DD Default: yesterday Example: 2019-08-15
Switch between cumulative and average score
Type: string Default: cum Enum: cum,avg
[
{
"val": "4.309",
"date": "2019-02-05"
}
]An overview of the models available in this version of the API
id Unique id of the company
Type: number Format: long
name Name of the company
Type: String
id Unique id of the location
Type: number Format: long
name Name of the location
Type: String
has_integrations Whether or not the location has integrations connected
Type: boolean
contact_details.phone Phone number of the location
Type: String
contact_details.website Website of the location
Type: String Format: url
contact_details.email Email of the location
Type: String Format: email
address_details.street Street portion of the address
Type: String
address_details.city City portion of the location
Type: String
address_details.country Country portion of the location
Type: String Format: ISO 3166-2
address_details.zip Zip code portion of the location
Type: String
address_details.lat Latitude coordinate of the location
Type: float Min: -90 Max: 90
address_details.lng Longitude coordinate of the location
Type: float Min: -180 Max: 180
val NPS score for this period
Type: number Format: float Min: -100 Max: 100
date Date for this period (only when group_by = day)
Type: string Format: YYYY-MM-DD
start Start date for this period (only when group_by != day)
Type: string Format: YYYY-MM-DD
end End date for this period (only when group_by != day)
Type: string Format: YYYY-MM-DD
val The score for this period
Type: number Format: float Min: 0 Max: 5
date Date for this period (only when group_by = day)
Type: string Format: YYYY-MM-DD
start Start date for this period (only when group_by != day)
Type: string Format: YYYY-MM-DD
end End date for this period (only when group_by != day)
Type: string Format: YYYY-MM-DD
An overview of the custom error codes that will be sent as part of the meta object on 400 badrequest calls when validation errors occur