Cancellations

This report contains details and key figures on ride cancellations. It only counts cancellations that follow a successful booking.

  • The period type is monthly.
  • The default query timeframe is seven days.
  • The row access mode is product and operator based.

Permissions: access_reports

Report columns

Field nameDefinitionAttribute / Calculation
Cancellation time (cancelled_at) defaultTimestamp of when the ride was canceled.ride.cancelled_at
Cancellation reason (cancellation_reason) defaultSource/reason of the cancellation. Possible values: payment_reservation_failed, passenger_cancelled, operator_cancelled, driver_cancelled, platform_cancelledride.cancellation_reason
Cancellation statement (cancellation_statement_name) defaultThe English translation of the cancellation statement (if there is one). This is the statement chosen by the canceller. If none was chosen this is empty.ride.cancellation_statement.translations&.[](:en)&.[](:title)
Canceller ID (cancelled_by_id)Unique ID in the ioki system of the user, driver, admin, or platform who canceled the ride. If not applicable (e.g., for payment_reservation_failed ) this is empty.ride.canceller_id
Canceled on behalf (cancelled_on_behalf)If the ride was canceled by an admin on behalf of a driver or passenger, this fact is displayed here. (driver or passenger)ride.cancellation_statement.present? => canceller fits cancellation_statement_group? => nil : driver/passenger
Cancellation lead time [min] (cancellation_lead_time) defaultMinutes before or after the pickup time the ride has been canceled.applied_pcm.pickup_calculated_negotiation_time - ride.cancelled_at).round
Canceled within [min] (cancelled_within) defaultTime between when the passenger accepted the ride and when it was canceled.(ride.cancelled_at - ride.passenger_accepted_at).round
State before cancellation (state_before_cancellation)The state of the ride before it was canceled.ride.state_before_cancellation
Ride ID (ride_id)Unique ID of the ride in the ioki system.ride.id
User ID (user_id )Unique ID of the user corresponding to the ride in the ioki system.ride.user.id
Offered pickup time (offered_pickup_time)Negotiated pickup time after ride was inserted into the task list.applied_pcm.pickup_calculated_negotiation_time
Deviation from requested time [min] (deviation_from_requested_time)The time difference of the requested time to when the journey (ride and walking times to pickup / from dropoff) starts or ends, respectively.Departure based:
applied_pcm.pickup_calculated_negotiation_time - origin.time - walking_time

Arrival based:
destination.time_max - applied_pcm.dropoff_calculated_negotiation_time_max - walking_time
Pickup lat (pickup_lat)The latitude of the geopoint of the planned pickup task, e.g., the latitude defined on the station.ride.pickup.lat calculated_point.geopoint.lat
Pickup lng (pickup_lng)The longitude of the geopoint of the planned pickup task.ride.pickup.lng calculated_point.lng
Dropoff lat (dropoff_lat)The latitude of the geopoint of the planned dropoff task, e.g., the latitude defined on the station.ride.dropoff.lat (calculated_point.geo_point)
Dropoff lng (dropoff_lng)The longitude of the geopoint of the planned dropoff task.ride.dropoff.lng (calculated_point.geo_point)
Part of serial booking (part_of_serial_booking)States if the ride was part of a serial booking (product feature).ride.ride_series_id.present
Fee (fee)Cancellation fee amount.ride.fare.final_price
Fee type (fee_type)Type of the cancellation fee (free_cancellation, cancellation_fee, no_show_fee)ride.fare.fee_type
Canceled fare (cancelled_fare)Booking price of the ride if it hadn’t been canceled.ride.fare.booking_price
License plate (license_plate)License plate of the vehicle that would have served the ride.ride.vehicle.license_plate
Operator ID (operator_id)Unique ID of the operator associated to the ride.ride.operator
Matching configuration ID (matching_config_id)ID of the applied matching configuration.ride.matched_task_list.matching_configuration
Matching configuration (matching_config_name)Name of the applied matching configuration.ride.matched_task_list.matching_configuration
Line name (line_name)Name of the line if vehicle planning was assigned to one.ride.matched_task_list.line
Product ID (product_id)Unique ID of the product in which the ride was booked.ride.product
Product name (product_name)Name of the product the ride was booked in.ride.product