Skip to main content
Stays is a property management system (PMS) for short-term rentals and vacation properties. It helps hosts and property managers handle reservations, guest communication, pricing, channel distribution, and operational workflows from a single platform.

​
Configuring Stays as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Stays option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You’ll need to provide your Stays API credentials. These can be obtained from your Stays account manager or through the Stays developer portal. The following configurations are available:
  • API URL: The base URL for the Stays API (e.g. https://api.stays.net/external/v1).
  • Username: The username used to authenticate against the Stays API.
  • Password: The password used to authenticate against the Stays API.

​
Advanced settings

  • Reservations Export Settings: Configuration for the reservations export stream, including start date, end date, and a lookback window (in days) to re-fetch recently updated reservations.
  • Reviews Settings: Requires a separate login for the Stays internal system. Provide the email and password used to access the internal reviews export, along with optional start/end dates and lookback window.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data.
    • Full table: every time the extraction happens, we’ll get the current state of the data.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

Below you’ll find all available data streams from Stays and their corresponding fields:
FieldTypeDescription
_idstringUnique reservation identifier
idstringReservation ID
typestringReservation type (reserved, booked, contract, blocked, maintenance, canceled)
currencystringCurrency code
creationDatestringDate the reservation was created
forwardingDatestringDate the reservation was forwarded
checkInDatestringCheck-in date
checkOutDatestringCheck-out date
guestTotalCountintegerTotal number of guests
nightCountintegerNumber of nights
pricePerNightnumberPrice per night
reserveTotalnumberTotal reservation amount
listingInvoiceTotalnumberTotal listing invoice amount
extraServicesTotalnumberTotal extra services amount
listingobjectListing details (id, internalName)
baseAmountForwardingnumberBase forwarding amount
sellPriceCorrectednumberCorrected sell price
companyCommisionnumberCompany commission amount
buyPricenumberBuy price
totalForwardFeenumberTotal forward fee
clientobjectClient details (name, firstName, lastName, email, phoneNumber)
hasReviewbooleanWhether the reservation has a review
partnerNamestringPartner name
agentNamestringAgent name
feearrayList of fees (val, desc)
ownerFeearrayList of owner fees (val, desc)
documentsarrayList of documents (type, numb, issued, date)
partnerCodestringPartner code
observationstringObservation notes
FieldTypeDescription
_idstringInternal reservation ID
idstringReservation ID
creationDatestringDate the reservation was created
checkInDatestringCheck-in date
checkInTimestringCheck-in time
checkOutDatestringCheck-out date
checkOutTimestringCheck-out time
_idlistingstringListing ID
_idclientstringClient ID
typestringReservation type
operatorobjectOperator details (id, name)
agentobjectAgent details (id, name)
priceobjectPrice breakdown (currency, expected, total, hosting details, extras details)
statsobjectPayment statistics (totalPaid)
guestsintegerTotal number of guests
guestsDetailsobjectGuest breakdown (adults, children, infants, guest list with contact info and documents)
partnerobjectPartner details (id, name, commission)
internalNotestringInternal note
partnerCodestringPartner code
_idpromoCodestringPromo code ID
reservationUrlstringReservation URL
messagestringMessage
errorsarrayError details (path, message, errorCode)
FieldTypeDescription
_idstringUnique promo code identifier
namestringPromo code name
statusstringPromo code status
typestringDiscount type
_f_discountnumberDiscount value
usedCountintegerNumber of times used
usedCountPerGuestintegerNumber of times used per guest
maxUsesCountintegerMaximum number of uses
maxUsesCountPerGuestintegerMaximum uses per guest
useWithOtherPromotionsbooleanWhether it can be combined with other promotions
_mcdiscountobjectMulti-currency discount values (BRL, USD, EUR)
periodRestrictionsobjectPeriod restrictions (enable, from, to, invalidDaysOfWeek)
calendarRestrictionsobjectCalendar restrictions (arrival/departure date ranges, minLengthOfStay)
productRestrictionsobjectProduct restrictions (bedrooms, listings limit)
userRestrictionsobjectUser restrictions (emails, minReservationsCount, maxGuestsCount)
targetstringTarget
Requires separate internal system credentials configured in the Reviews Settings.
FieldTypeDescription
_idstringUnique review identifier (generated hash)
statusstringReview status
hospedestringGuest name
id_do_anunciostringListing ID
listing_internal_namestringListing internal name
datastringReview date
external_reserve_idstringExternal reservation ID
external_channel_namestringExternal channel name (Airbnb, Booking, etc.)
avaliacaonumberOverall rating
cleaning_ratingnumberCleaning rating
checkinnumberCheck-in rating
checkoutnumberCheckout rating
processo_de_reservanumberBooking process rating
manutencaonumberMaintenance rating
cliente_treatmentnumberClient treatment rating
pontos_positivosstringPositive points
pontos_negativosstringNegative points
comentariosstringComments
listing_accuracynumberListing accuracy rating
limpezanumberCleanliness rating
comunicacaonumberCommunication rating
localizacaonumberLocation rating
valornumberValue rating
feedback_privadostringPrivate feedback
feedback_publicostringPublic feedback
original_cleanlinessnumberOriginal cleanliness score
original_facilitiesnumberOriginal facilities score
original_locationnumberOriginal location score
original_servicesnumberOriginal services score
original_staffnumberOriginal staff score
original_amountnumberOriginal amount score
original_ratingnumberOriginal overall rating
titulo_da_avaliacaostringReview title
positivostringPositive feedback
negativostringNegative feedback
comentarios_do_hospedestringGuest comments
_date_timedatetimeExport date/time