Skip to content

Commit c7dee62

Browse files
committed
Merge branch 'dev' into feature-agency-provider-api-alignment
2 parents e934268 + 5bd0f3b commit c7dee62

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

provider/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -342,15 +342,15 @@ The authenticated reports are monthly, historic flat files that may be pre-gener
342342
**`data` Filename:** monthly file named by year and month, e.g. `/reports/YYYY-MM.csv`
343343
**`data` Payload:** monthly CSV files with the following structure:
344344

345-
| Name | Type | Comments |
346-
| ------------------ | ----------------------------------------- | ------------------------------------------------ |
347-
| StartDate | date | Start date of trip the data row, ISO 8601 format, local timezone |
348-
| Duration | string | Value is always `P1M` for monthly. Based on [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) |
349-
| Special Group Type | [Special Group Type](#special-group-type) | Type that applies to this row |
350-
| Geography ID | [Geography](/geography) | ID that applies to this row. Includes all IDs in /geography. When there is no /geography then return `null` for this value and return counts based on the entire operating area. |
351-
| Vehicle Type | [Vehicle Type](/agency#vehicle-type) | Type that applies to this row |
352-
| Trip Count | integer | Count of trips taken for this row |
353-
| Rider Count | integer | Count of unique riders for this row |
345+
| Column Name | Type | Comments |
346+
|----------------------| ----------------------------------------- | ------------------------------------------------ |
347+
| `start_date` | date | Start date of trip the data row, ISO 8601 format, local timezone |
348+
| `duration` | string | Value is always `P1M` for monthly. Based on [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) |
349+
| `special_group_type` | [Special Group Type](#special-group-type) | Type that applies to this row |
350+
| `geography_id` | [Geography](/geography) | ID that applies to this row. Includes all IDs in /geography. When there is no /geography then return `null` for this value and return counts based on the entire operating area. |
351+
| `vehicle_type` | [Vehicle Type](/agency#vehicle-type) | Type that applies to this row |
352+
| `trip_count` | integer | Count of trips taken for this row |
353+
| `rider_count` | integer | Count of unique riders for this row |
354354

355355
#### Data Notes
356356

@@ -369,7 +369,7 @@ For 3 months of provider operation in a city (September 2019 through November 20
369369
**September 2019** `/reports/2019-09.csv`
370370

371371
```csv
372-
StartDate,Duration,Special Group Type,Geography ID,Vehicle Type,Trip Count,Rider Count
372+
start_date,duration,special_group_type,geography_id,vehicle_type,trip_count,rider_count
373373
2019-09-01T00:00-04,P1M,all_riders,44428624-186b-4fc3-a7fb-124f487464a1,scooter,1302,983
374374
2019-09-01T00:00-04,P1M,low_income,44428624-186b-4fc3-a7fb-124f487464a1,scooter,201,104
375375
2019-09-01T00:00-04,P1M,all_riders,44428624-186b-4fc3-a7fb-124f487464a1,bicycle,530,200
@@ -387,7 +387,7 @@ StartDate,Duration,Special Group Type,Geography ID,Vehicle Type,Trip Count,Rider
387387
**October 2019** `/reports/2019-10.csv`
388388

389389
```csv
390-
StartDate,Duration,Special Group Type,Geography ID,Vehicle Type,Trip Count,Rider Count
390+
start_date,duration,special_group_type,geography_id,vehicle_type,trip_count,rider_count
391391
2019-10-01T00:00-04,P1M,all_riders,44428624-186b-4fc3-a7fb-124f487464a1,scooter,1042,786
392392
2019-10-01T00:00-04,P1M,low_income,44428624-186b-4fc3-a7fb-124f487464a1,scooter,161,83
393393
2019-10-01T00:00-04,P1M,all_riders,44428624-186b-4fc3-a7fb-124f487464a1,bicycle,424,160
@@ -405,7 +405,7 @@ StartDate,Duration,Special Group Type,Geography ID,Vehicle Type,Trip Count,Rider
405405
**November 2019** `/reports/2019-11.csv`
406406

407407
```csv
408-
StartDate,Duration,Special Group Type,Geography ID,Vehicle Type,Trip Count,Rider Count
408+
start_date,duration,special_group_type,geography_id,vehicle_type,trip_count,rider_count
409409
2019-11-01T00:00-05,P1M,all_riders,44428624-186b-4fc3-a7fb-124f487464a1,scooter,834,629
410410
2019-11-01T00:00-05,P1M,low_income,44428624-186b-4fc3-a7fb-124f487464a1,scooter,129,66
411411
2019-11-01T00:00-05,P1M,all_riders,44428624-186b-4fc3-a7fb-124f487464a1,bicycle,339,128

0 commit comments

Comments
 (0)