Passenger fare revenue
This report contains the individual fares of dropped-off rides and the factors that influence the fare calculation. It has one row per passenger of each ride. The passenger options and ride options it takes into account are configurable.
- The period type is monthly.
- The default query timeframe is seven days.
- The row access mode is
product and operator based.
Permissions:
access_reports
Passenger options and ride options that are assigned to a report column are also shown as columns. The displayed column names can be customized in the provider-level custom report column name settings for passenger options and ride options.
Amounts that apply to the whole ride rather than to one passenger are split across the passengers of the ride.
Report columns
Columns marked default appear in the data table by default. All columns are available for export. For more information, see Working with the data table and Exporting data.
| Field name | Definition |
|---|---|
Ride ID (ride_id) default | Unique ID of the ride |
User ID (user_id) | Unique ID of the user who booked the ride |
Requested time (requested_time) | Requested time for departure or arrival |
Pickup time (picked_up_at) | The time when the passenger was picked up |
Dropoff time (dropped_off_at) default | The time when the passenger was dropped off. The report’s date range filters on this time. |
Estimated direct routing distance (direct_routing_distance) | Estimated distance of the direct route between the requested origin and destination |
Fare matrix zone code (fare_matrix_zone_code) | If a fare matrix is used for pricing, its result for the ride’s origin and destination |
Pickup station tariff code (pickup_station_tariff_code) | Tariff code of the pickup station that was used to calculate the fare |
Dropoff station tariff code (dropoff_station_tariff_code) | Tariff code of the dropoff station that was used to calculate the fare |
Passenger position (passenger_position) default | Position of the passenger within the booking, starting at 1 |
Passenger type (passenger_type) default | The type of passenger, for example adult or child |
Passenger option report columns (dynamic_passenger_option_1 to dynamic_passenger_option_20) | Values of the bookable passenger options assigned to report columns |
Ride option report columns (dynamic_ride_option_1 to dynamic_ride_option_4) | Values of the bookable ride options assigned to report columns |
Base price (base_price) default | Base price for the passenger |
Base price currency (base_price_currency) | Currency of the base price |
Total surcharges (total_surcharges) default | Sum of the surcharges added to the base price for the passenger |
Surcharges currency (total_surcharges_currency) | Currency of the surcharges |
Total discounts (total_discounts) default | Sum of the discounts subtracted from the fare for the passenger |
Discounts currency (total_discounts_currency) | Currency of the discounts |
Personal discount type (personal_discount_type) | Title of the personal discount type behind the applied personal discount |
Personal discount amount (personal_discount_amount) default | Personal discount amount that applies to the passenger |
Personal discount amount currency (personal_discount_amount_currency) | Currency of the personal discount amount |
Final fare (final_fare) default | Sum of the base price, surcharges, discounts, and personal discount for the passenger |
Final fare currency (final_fare_currency) | Currency of the final fare |
Pricing Version (pricing_version) | Version of the pricing that was used to calculate the fare, if the fare calculation provides one |
Product ID (product_id) | Unique ID of the product |
Product name (product_name) | Name of the product |
Vehicle ID (vehicle_id) | Unique ID of the vehicle that served the ride |
License plate (license_plate) | License plate of the vehicle that served the ride |
Driver ID (driver_id) | Unique ID of the driver who completed the pickup. If an administrator completed the pickup on the driver’s behalf, this is the driver who was connected to the vehicle at the reported pickup time or, if there is none, the last driver connected to the vehicle planning. Empty if no driver is recorded for the pickup. |
Driver external ID (driver_external_id) | External ID of the same driver as in Driver ID. Empty if the driver has no external ID. |
Matching configuration ID (matching_config_id) | Unique ID of the matching configuration |
Matching configuration (matching_config_name) | Name of the matching configuration |
Operator ID (operator_id) | Unique ID of the operator |
Operator name (operator_name) | Name of the operator |
Booking client (booking_client) | Type of application the ride was booked with: iOS, Android, Webbooking, Operator, or Platform. Platform means an external API integration. |
Driver ID and Driver external ID were added to this report later. Reports for months that started before these columns were added may not include them.