Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

query API for network statistics #1

Open
8 of 11 tasks
drewda opened this issue Mar 8, 2017 · 0 comments
Open
8 of 11 tasks

query API for network statistics #1

drewda opened this issue Mar 8, 2017 · 0 comments
Assignees

Comments

@drewda
Copy link
Contributor

drewda commented Mar 8, 2017

The Datastore API will support a range of live queries for simple analysis of roadway network statistics.

The Datastore API will offer similar functionality to the existing POC's Traffic Engine API, which is partially documented at https://github.com/WorldBank-Transport/traffic-engine-app/wiki/Functionality-Overview

(Note the Datastore API will also offer an endpoint for traffic-influenced routing in the future--that work be fleshed out under another issue.)

query parameters to accept for the network statistics API endpoint:

  • bounding box for geographic extent [required]
  • start datetime and end datetime for temporal extent [optional]
  • array of one or more days-of-week (Monday, Tuesday, etc.) to filter results by day(s) [optional]
  • array of one or more hours-of-day (00:00, 01:00, 02:00, etc.) to filter results by hour(s) [optional]
  • comparison start datetime and comparison end datetime, when comparing between two temporal extents [optional]

The only query parameter that should be required is bounding box. All temporal query parameters are optional.

response contents:

  • geometries (as GeoJSON)
  • overall average speed per segment across entire temporal extent
  • average speed per segment by hour + day per week (to power bar charts)
  • observation count per segment by hour + day per week (only for authorized users)
  • When comparing across two different timeframes, also:
    • significance figure from a two-sample paired t-test
    • percentage change in speed by day of week + hour of day (to power bar charts)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants