diff --git a/README.md b/README.md index 758cb52..9e478ec 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,6 @@ If you have any trouble using the app, please send an email to Nate Wessel (nate ## Outputs The app can return results in either CSV or JSON format. The fields in either case are the same. There will be one column for each of the input parameters: -* corridor * time range * date range * days of week @@ -32,10 +31,14 @@ The app can return results in either CSV or JSON format. The fields in either ca The other fields may require some explanation: -| Field | Description | +| Field | Description | |----|----| +| `routeStreets` | The name(s) of the streets along the corridor. I.e. the path taken. | +| `startCrossStreets` | The names of any cross-street(s) at the start of the corridor. If the corridor starts mid-block then coordinates of that point will be returned instead. | +| `endCrossStreets` | The names of any cross-street(s) at the end of the corridor. If the corridor ends mid-block then coordinates of that point will be returned instead. | | `mean_travel_time_minutes` | The mean travel time in minutes is given as a floating point number rounded to two decimal places. Where insufficient data was available to complete the request, the value will be null, and in cases where the request was impossible a value of -999 will be assigned. (See `hoursInRange` below). | -| `URI` | The URI is the API endpoint that corresponds to this exect request. It may be of little use to some end users but may help us to reproduce the request and verify data quality. It can also serve as a unique ID. | +| `mean_travel_time_seconds` | Same as above, but measured in seconds. | +| `URI` | The URI is the API endpoint that corresponds to this exect request. It may be of little use to some end users but can help us to reproduce the request and verify data quality. It can also serve as a unique ID for the record. | | `hoursInRange` | The total number of hours that are theoretically within the scope of this request. This does not imply that data is/was available at all times. It's possible to construct requests with zero hours in range such as e.g `2023-01-01` to `2023-01-02`, Mondays only (There's only one Sunday in that range). Impossible combinations are included in the output for clarity and completeness but are not actually executed against the API and should return an error. | | `estimatedVehicleCount` | A very rough estimate of the number of actual vehicles traversing the corridor within the given temporal bounds. Includes partial trips through the corridor and may be subject to additional caveats which we are still exploring. |