reporting schema

This commit is contained in:
Pablo Martin 2024-09-12 15:39:49 +02:00
parent 05d5cc6d10
commit df16cdb00c
4 changed files with 109 additions and 144 deletions

View file

@ -161,7 +161,7 @@ models:
currency.
This fee is calculated by finding what was the active price plan for the host user
when the booking fee had to be charged.
when the booking fee had to be charged.
- name: booking_fee_charge_at_utc
data_type: timestamp without time zone
@ -191,7 +191,7 @@ models:
columns:
- name: id_verification_request
data_type: bigint
description: |
description: |
Unique, incremental, internal ID for the related verification
request.
tests:
@ -220,25 +220,25 @@ models:
- name: is_verification_request_complete
data_type: boolean
description: |
description: |
True if the verification request is considered is considered
complete, AKA the guest has finished the full guest journey.
- name: is_past_check_in
data_type: boolean
description: |
description: |
True if the check-in date is in the past, false otherwise. This value
only gets informed for users who have bought check-in cover.
- name: is_awaiting_check_in
data_type: boolean
description: |
description: |
True if the check-in date is in the future, false otherwise. This
value only gets informed for users who have bought check-in cover.
- name: cover_was_purchased
data_type: boolean
description: |
description: |
True if the guest purchased the check-in cover.
This is identified by the fact that there is a payment of type
@ -246,8 +246,7 @@ models:
- name: address_validation_passed
data_type: boolean
description:
"Boolean to indicate if the validation was approved or not.
description: "Boolean to indicate if the validation was approved or not.
In case there was a problem with the validation it will be Null"
- name: address_validation_notes
@ -307,7 +306,7 @@ models:
- name: verification_start_at_utc
data_type: timestamp without time zone
description: |
description: |
The date and time at which the guest started the guest journey.
- name: verification_start_date_utc
@ -326,7 +325,7 @@ models:
- name: amount_in_txn_currency
data_type: numeric
description: |
description: |
The amount paid by the guest for the check-in cover, in the currency
in which the payment actually took place.
@ -348,7 +347,7 @@ models:
- name: checkin_cover_cover_amount_local_curr
data_type: numeric
description: |
description: |
The total amount for which the guest check-in is covered, according
to the Superhog backend, in the same currency as the guest payment.
@ -385,18 +384,18 @@ models:
For more details, contact pablo.martin or Lawrence.
- name: core__verification_requests
description:
description:
This is a table that shows all guest journey from our guests users with
each record matching each guest journey.
It holds information about the guests like name, email, phone, etc.., as
well as dates regarding the process of the guest journey like when it
well as dates regarding the process of the guest journey like when it
was started or finished.
columns:
- name: id_verification_request
data_type: bigint
description:
Unique, incremental, internal ID for the related verification
description:
Unique, incremental, internal ID for the related verification
request.
- name: uuid_verification_request
@ -425,7 +424,7 @@ models:
- name: is_verification_request_complete
data_type: boolean
description: True if the verification request is considered
description: True if the verification request is considered
complete, AKA the guest has finished the full guest journey.
- name: verification_url
@ -470,43 +469,35 @@ models:
- name: verification_start_at_utc
data_type: timestamp without time zone
description:
The date and time at which the guest started the guest journey.
description: The date and time at which the guest started the guest journey.
- name: verification_start_date_utc
data_type: date
description:
The date on which the guest started the guest journey.
description: The date on which the guest started the guest journey.
- name: verification_end_at_utc
data_type: timestamp without time zone
description:
The date and time at which the guest finished the guest journey.
description: The date and time at which the guest finished the guest journey.
- name: verification_end_date_utc
data_type: date
description:
The date on which the guest finished the guest journey.
description: The date on which the guest finished the guest journey.
- name: link_used_at_utc
data_type: timestamp without time zone
description:
The date and time at which the guest used the link for the verification.
description: The date and time at which the guest used the link for the verification.
- name: link_used_date_utc
data_type: date
description:
The date on which the guest used the link for the verification.
description: The date on which the guest used the link for the verification.
- name: expire_at_utc
data_type: timestamp without time zone
description:
The date and time at which the link for the verification expires.
description: The date and time at which the link for the verification expires.
- name: expire_date_utc
data_type: date
description:
The date on which the link for the verification expires.
description: The date on which the link for the verification expires.
- name: is_deleted
data_type: boolean
@ -532,8 +523,7 @@ models:
- name: rejection_reason
data_type: character varying
description:
Reason as to why the guest was rejected.
description: Reason as to why the guest was rejected.
- name: has_switched_to_mobile
data_type: boolean
@ -555,30 +545,26 @@ models:
- name: created_at_utc
data_type: timestamp without time zone
description:
The date and time at which the verification process was created.
description: The date and time at which the verification process was created.
- name: created_date_utc
data_type: date
description:
The date on which the verification process was created.
description: The date on which the verification process was created.
- name: updated_at_utc
data_type: timestamp without time zone
description:
The date and time at which the last update on the entry happened.
description: The date and time at which the last update on the entry happened.
- name: updated_date_utc
data_type: date
description:
The date on which the last update on the entry happened.
description: The date on which the last update on the entry happened.
- name: dwh_extracted_at_utc
data_type: timestamp with time zone
description: ""
- name: core__unified_user
description:
description:
This is a table to join data from all users of Superhog (hosts, PMs, guests, etc).
It contains details of every user like name, last name, email address, etc.
@ -589,7 +575,7 @@ models:
tests:
- unique
- not_null
- name: id_account_type
data_type: bigint
description: Internal ID for type of user.
@ -632,13 +618,11 @@ models:
- name: joined_at_utc
data_type: timestamp without time zone
description:
The date time when the user created it's account in Superhog.
description: The date time when the user created it's account in Superhog.
- name: joined_date_utc
data_type: date
description:
The date when the user created it's account in Superhog.
description: The date when the user created it's account in Superhog.
- name: user_name
data_type: character varying
@ -694,13 +678,11 @@ models:
- name: created_date_utc
data_type: timestamp without time zone
description:
The date time when the user data was created.
description: The date time when the user data was created.
- name: updated_date_utc
data_type: timestamp without time zone
description:
The date when the user data was created.
description: The date when the user data was created.
- name: verified_at_utc
data_type: timestamp without time zone
@ -735,7 +717,7 @@ models:
description: ""
- name: core__check_in_cover_users
description:
description:
This model contains information about hosts that offer check in cover.
It has basic information on the users like name, phone, email or joined date.
@ -783,8 +765,7 @@ models:
- name: check_in_cover_added_date_utc
data_type: date
description:
Date the user first included check-in cover
description: Date the user first included check-in cover
- name: billing_town
data_type: character varying
@ -795,7 +776,7 @@ models:
description: ""
- name: core__guest_satisfaction_responses
description:
description:
This model contains information on guests satisfaction survey responses,
it contains some basic information on the guests, a rating of their experience
and some comments on it.
@ -818,28 +799,25 @@ models:
- name: verification_request_booking_source
data_type: text
description:
Source type of host of the booking, this could be either;
description: Source type of host of the booking, this could be either;
- PMS
- OSL
- API/MANUAL
tests:
- not_null
- accepted_values:
values:
- 'PMS'
- 'OSL'
- 'API/MANUAL'
values:
- "PMS"
- "OSL"
- "API/MANUAL"
- name: experience_rating
data_type: bigint
description:
Guest rating of their experience with Superhog from 1 to 5
description: Guest rating of their experience with Superhog from 1 to 5
- name: guest_comments
data_type: character varying
description:
Guest comments on their experience with Superhog
description: Guest comments on their experience with Superhog
- name: is_contactable
data_type: boolean
@ -848,13 +826,11 @@ models:
- name: created_at_utc
data_type: timestamp without time zone
description:
Date and time of response creation
description: Date and time of response creation
- name: updated_at_utc
data_type: timestamp without time zone
description:
Date and time of last update of response
description: Date and time of last update of response
- name: selected_payment_option
data_type: character varying
@ -889,13 +865,12 @@ models:
True if guest payed the fee
- name: core__check_in_cover_listings
description:
This model contains information about hosts and their listings
description: This model contains information about hosts and their listings
that offer check in cover.
It has basic information on the users and listings like country,
town, address and if they are active or not.
This model is restricted to active user so it doesn't include historical
This model is restricted to active user so it doesn't include historical
data like users that had check-in cover but are currently inactive.
columns:
- name: id_user_host
@ -938,8 +913,7 @@ models:
- name: check_in_cover_added_date_utc
data_type: date
description:
Date the user first included check-in cover
description: Date the user first included check-in cover
- name: billing_town
data_type: character varying
@ -982,15 +956,13 @@ models:
- name: check_in_cover_purchased
data_type: bigint
description:
"Count of how many Check-in covers have been
description: "Count of how many Check-in covers have been
purchased for this accommodation"
- name: core__host_booking_fees
description:
Bookings that have been processed by the Superhog backend.
description: Bookings that have been processed by the Superhog backend.
Each record matches one booking and has information on host
booking fees, when they were charged and the currency used by
booking fees, when they were charged and the currency used by
the host.
columns:
@ -1017,7 +989,7 @@ models:
- name: booking_state
data_type: character varying
description:
description:
"State in which the booking is, could be either of the following:
- Approved
- NotApproved
@ -1026,20 +998,20 @@ models:
- NoFlags
- Flagged
- IncompleteInformation"
tests:
tests:
- accepted_values:
values:
- 'Approved'
- 'NotApproved'
- 'Cancelled'
- 'Rejected'
- 'NoFlags'
- 'Flagged'
- 'IncompleteInformation'
values:
- "Approved"
- "NotApproved"
- "Cancelled"
- "Rejected"
- "NoFlags"
- "Flagged"
- "IncompleteInformation"
- name: is_duplicate_booking
data_type: boolean
description: |
description: |
A flag that identifies whether the booking is a duplicate.
A booking is considered a duplicate if there's an older booking with the same user,
accomodation and check-in date. If there are two or more bookings with the same user,
@ -1151,7 +1123,7 @@ models:
Count of listings that the user owns.
It contains only those that can accept bookings (hard
activation - not to be confused with activity-based
segmentation).
segmentation).
- name: total_listings_with_product_bundle_with_paid_service
data_type: integer
@ -1195,7 +1167,7 @@ models:
data_type: integer
description: |
Integer-based flag version of total_bookings_with_product_bundle.
- name: has_bookings_with_product_bundle_with_paid_service
data_type: integer
description: |