get
/api/v2/traffic/harsh-events/{id}Python SDK method:
client.traffic.harsh_events_per_segment(id=job_id).results()Get harsh events per segment results
Returns paginated harsh event metric rows per road segment for a completed harsh events per segment analysis job.
Altitude Help Center — getHarshEventsPerSegmentInput Parameters
| Name | Location | Type | Values | Description | Value Required |
|---|---|---|---|---|---|
id | path | string | - | Unique resource identifier. | Y |
pageToken | query | string | - | Pagination token returned in the Link header of a previous response. Omit to fetch the first page. | N |
Success Responses
200 response: object
Paginated result data. When more pages are available, a Link: rel="next" header and Altitude-* pagination headers are included in the response.
| Name | Type | Description |
|---|---|---|
accelerationEventsPerTenThousandTrips | number (double) | The count of acceleration harsh events along a road segment per 10,000 vehicle traversals. |
brakingEventsPerTenThousandTrips | number (double) | The count of braking harsh events along a road segment per 10,000 vehicle traversals. |
cardinalDirection | string | The direction of the road segment in terms of 'N', 'NE', 'E', etc. |
corneringEventsPerTenThousandTrips | number (double) | The count of cornering harsh events along a road segment per 10,000 vehicle traversals. |
direction | integer (int64) | Indicates the direction of traffic flow in relation to the definition of the segment geography. For directional analysis: 1 indicates traffic in the direction of the segment; -1 indicates the opposite direction. For non-directional analysis: value is always 0. |
harshEventsByHour | array<object> | Array of objects representing the observed count of harsh events by hour. |
harshEventsByIndustry | array<object> | Array of objects representing the observed count of harsh events by industry. |
harshEventsByMagnitude | array<object> | Array of objects representing the observed count of harsh events by magnitude bins. |
harshEventsByVehicleClass | array<object> | Array of objects representing the observed count of harsh events by vehicle class. |
harshEventsByVocation | array<object> | Array of objects representing the observed count of harsh events by vocation. |
harshEventsPerTenThousandTrips | number (double) | The count of total harsh events along a road segment per 10,000 vehicle traversals. |
observedAccelerationEvents | integer (int64) | The count of acceleration based harsh events along a road segment for the given time. |
observedBrakingEvents | integer (int64) | The count of braking based harsh events along a road segment for the given time. |
observedCorneringEvents | integer (int64) | The count of cornering based harsh events along a road segment for the given time. |
observedCount | integer (int64) | The aggregate number of observed vehicle traversals for the road segment, given the applied filters. |
observedHarshEvents | integer (int64) | The count of total harsh events along a road segment for the given time. |
roadType | string | OSM road type. |
segmentId | string | The ID of the road segment. |
segmentLength | number (double) | The length of the segment in metric units (kilometers) or imperial units (miles) based on the value of isMetric. |
Response Errors
| HTTP Status Code | Reason |
|---|---|
| 400 | The request body or parameters are invalid. |
| 401 | Authentication is required or the provided credentials are invalid. |
| 403 | The authenticated user lacks permission to perform this operation. |
| 404 | The requested resource does not exist. |
| 409 | Result not yet ready. Poll the status monitor. |
| 429 | The request rate limit has been exceeded. |
| 500 | An unexpected server error occurred. |
