Aggregate passenger experience, sentiment and operational insight. Requires an enterprise subscription.
GET/api/v1/passengers/aggregate_passenger_insightaggregate_passenger_insightpassengers:readTier g₦2,000.00Requires enterprise subscription
Returns aggregate passenger participation counts, distinct passenger totals and status distribution across the requested journey scope.
Parameters
| Name | In | Type | Required | Description |
|---|
| journey_id | query | string | No | Optional UUID of a single owned journey that narrows the aggregates to that journey. |
| days | query | integer | No | Optional lookback window in days, clamped to 1 through 90 with a default of 30. |
Idempotency
Safe read; no side effects.
Response
Aggregated passenger insight. Raw and text answers are never returned.
{
"data": {
"journey_id": "0d0b6f2e-6b1a-4f3e-9a4c-1f2e3d4c5b6a",
"aggregation_policy": "aggregate_only",
"raw_responses_returned": false,
"text_answers_returned": false,
"participation": {
"passengers": 12,
"by_status": {
"reserved": 2,
"boarded": 9,
"completed": 1,
"cancelled": 0
}
},
"ratings": {
"responses_total": 86,
"rated_responses": 86,
"distribution": {
"1": 2,
"2": 4,
"3": 11,
"4": 38,
"5": 31
},
"average_rating": 4.06,
"classification": {
"positive": 69,
"neutral": 11,
"negative": 6
}
}
}
}
Errors
| Code | HTTP | Cause |
|---|
| INVALID_REQUEST | 400 | The days parameter is not an integer or the journey_id parameter is not a valid resource identifier. |
| CAPABILITY_NOT_AUTHORIZED | 403 | Organization subscription tier does not include the passengers capability. |
| RESOURCE_NOT_FOUND | 404 | The requested journey was not found or is not owned by the linked ride-owner account. |
passengers:readTier g₦2,500.00Requires enterprise subscription
Returns rating based passenger experience aggregates with a seven day trend direction for the requested journey scope.
Parameters
| Name | In | Type | Required | Description |
|---|
| journey_id | query | string | No | Optional UUID of a single owned journey that narrows the aggregates to that journey. |
| days | query | integer | No | Optional lookback window in days, clamped to 1 through 90 with a default of 30. |
Idempotency
Safe read; no side effects.
Response
Experience summary with satisfaction trend.
{
"data": {
"journey_id": "0d0b6f2e-6b1a-4f3e-9a4c-1f2e3d4c5b6a",
"aggregation_policy": "aggregate_only",
"raw_responses_returned": false,
"text_answers_returned": false,
"ratings": {
"responses_total": 86,
"rated_responses": 86,
"distribution": {
"1": 2,
"2": 4,
"3": 11,
"4": 38,
"5": 31
},
"average_rating": 4.06,
"classification": {
"positive": 69,
"neutral": 11,
"negative": 6
}
},
"trend": {
"direction": "stable_or_improving",
"previous_average_rating": 3.94,
"current_average_rating": 4.06
}
}
}
Errors
| Code | HTTP | Cause |
|---|
| INVALID_REQUEST | 400 | The days parameter is not an integer or the journey_id parameter is not a valid resource identifier. |
| CAPABILITY_NOT_AUTHORIZED | 403 | Organization subscription tier does not include the passengers capability. |
| RESOURCE_NOT_FOUND | 404 | The requested journey was not found or is not owned by the linked ride-owner account. |
passengers:readTier g₦3,000.00Requires enterprise subscription
Returns rating based sentiment buckets and a dominant sentiment label derived from one to five ratings for the requested journey scope.
Parameters
| Name | In | Type | Required | Description |
|---|
| journey_id | query | string | No | Optional UUID of a single owned journey that narrows the aggregates to that journey. |
| days | query | integer | No | Optional lookback window in days, clamped to 1 through 90 with a default of 30. |
Idempotency
Safe read; no side effects.
Response
Rating-based sentiment buckets. sentiment_basis is always "rating_based".
{
"data": {
"journey_id": "0d0b6f2e-6b1a-4f3e-9a4c-1f2e3d4c5b6a",
"aggregation_policy": "aggregate_only",
"raw_responses_returned": false,
"text_answers_returned": false,
"sentiment_basis": "rating_based",
"ratings": {
"responses_total": 86,
"rated_responses": 86,
"distribution": {
"1": 2,
"2": 4,
"3": 11,
"4": 38,
"5": 31
},
"average_rating": 4.06,
"classification": {
"positive": 69,
"neutral": 11,
"negative": 6
}
},
"sentiment": {
"positive": 69,
"neutral": 11,
"negative": 6
}
}
}
Errors
| Code | HTTP | Cause |
|---|
| INVALID_REQUEST | 400 | The days parameter is not an integer or the journey_id parameter is not a valid resource identifier. |
| CAPABILITY_NOT_AUTHORIZED | 403 | Organization subscription tier does not include the passengers capability. |
| RESOURCE_NOT_FOUND | 404 | The requested journey was not found or is not owned by the linked ride-owner account. |
passengers:readTier g₦3,500.00Requires enterprise subscription
Returns aggregate checkpoint, safety event and journey state posture relevant to passenger operations for the requested scope.
Parameters
| Name | In | Type | Required | Description |
|---|
| journey_id | query | string | No | Optional UUID of a single owned journey that narrows the aggregates to that journey. |
| days | query | integer | No | Optional lookback window in days, clamped to 1 through 90 with a default of 30. |
Idempotency
Safe read; no side effects.
Response
Operational view of passenger participation and feedback.
{
"data": {
"journey_id": "0d0b6f2e-6b1a-4f3e-9a4c-1f2e3d4c5b6a",
"aggregation_policy": "aggregate_only",
"raw_responses_returned": false,
"text_answers_returned": false,
"participation": {
"passengers": 12,
"by_status": {
"reserved": 2,
"boarded": 9,
"completed": 1,
"cancelled": 0
}
},
"ratings": {
"responses_total": 86,
"rated_responses": 86,
"distribution": {
"1": 2,
"2": 4,
"3": 11,
"4": 38,
"5": 31
},
"average_rating": 4.06,
"classification": {
"positive": 69,
"neutral": 11,
"negative": 6
}
},
"operational": {
"boarding_rate": 0.75,
"completion_rate": 0.083,
"feedback_response_rate": 0.717
}
}
}
Errors
| Code | HTTP | Cause |
|---|
| INVALID_REQUEST | 400 | The days parameter is not an integer or the journey_id parameter is not a valid resource identifier. |
| CAPABILITY_NOT_AUTHORIZED | 403 | Organization subscription tier does not include the passengers capability. |
| RESOURCE_NOT_FOUND | 404 | The requested journey was not found or is not owned by the linked ride-owner account. |
passengers:readTier g₦5,000.00Requires enterprise subscription
Returns fused experience rating and participation aggregates across the requested journey scope.
Parameters
| Name | In | Type | Required | Description |
|---|
| journey_id | query | string | No | Optional UUID of a single owned journey that narrows the aggregates to that journey. |
| days | query | integer | No | Optional lookback window in days, clamped to 1 through 90 with a default of 30. |
Idempotency
Safe read; no side effects.
Response
Fused advanced passenger intelligence across participation, ratings and sentiment.
{
"data": {
"journey_id": "0d0b6f2e-6b1a-4f3e-9a4c-1f2e3d4c5b6a",
"aggregation_policy": "aggregate_only",
"raw_responses_returned": false,
"text_answers_returned": false,
"sentiment_basis": "rating_based",
"participation": {
"passengers": 12,
"by_status": {
"reserved": 2,
"boarded": 9,
"completed": 1,
"cancelled": 0
}
},
"ratings": {
"responses_total": 86,
"rated_responses": 86,
"distribution": {
"1": 2,
"2": 4,
"3": 11,
"4": 38,
"5": 31
},
"average_rating": 4.06,
"classification": {
"positive": 69,
"neutral": 11,
"negative": 6
}
},
"sentiment": {
"positive": 69,
"neutral": 11,
"negative": 6
},
"trend": {
"direction": "stable_or_improving",
"previous_average_rating": 3.94,
"current_average_rating": 4.06
}
}
}
Errors
| Code | HTTP | Cause |
|---|
| INVALID_REQUEST | 400 | The days parameter is not an integer or the journey_id parameter is not a valid resource identifier. |
| CAPABILITY_NOT_AUTHORIZED | 403 | Organization subscription tier does not include the passengers capability. |
| RESOURCE_NOT_FOUND | 404 | The requested journey was not found or is not owned by the linked ride-owner account. |