Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

Group reports for a set of OSM usernames #15

Closed
ramyaragupathy opened this issue Oct 13, 2021 · 2 comments
Closed

Group reports for a set of OSM usernames #15

ramyaragupathy opened this issue Oct 13, 2021 · 2 comments

Comments

@ramyaragupathy
Copy link
Member

Given a set of usernames and hashtags, the endpoint should return statistics on feature contributions for individual users

As a permissioned user, I can input a set of OSM usernames, specify a date range and a set of hashtags so that I can generate a user contribution report for a given time period.

Endpoint: /osm-users/reports/ POST

Target Groups:
Training Group
Internal mapping projects
Data Quality team

Data Source:
Insights RDS

Sample request body:
{
“Osm_usernames”:[],
“Hashtags”:[],
"from_timestamp":"2021-08-27 09:00:00",
"to_timestamp":"2021-08-27 11:00:00",
“Period”: weekly/monthly

}

ACCEPTANCE CRITERIA:

  • Users are able to select from a calendar picker from and to dates

    • Frontend should handle UTC time conversion
    • Frontend should make sure both from and to dates are filled by the user
    • Required field
    • Should be handle to one month time interval
  • Hashtags

    • Default to ‘Any’
    • Users are able to search and type in hashtags.
    • All entered hashtags appear in the hashtag input form.
    • Not a required field
  • Users can provide a set of OSM usernames

    • Default to ‘Any ‘
    • All entered usernames should appear in the username input form.
    • Limit to 50 usernames
  • Let user download the result in file format

    • Binary field
    • Default value is false
  • Output file format

    • JSON - this is the default option
    • CSV - for the download option

Output :

JSON

{“contributors”:[
    “Username”:
    “Changesets”:
“Buildings_created”:
“Buildings_modified”:
“Editors”: []
]}

CSV Username|changesets|buildings_created|buildings_modified

  • Submit button displayed at the bottom of the page.
  • Submit button activated only when no errors found in submit API request form.
@ramyaragupathy
Copy link
Member Author

From discussion today w/ @d-rita @omranlm @JorgeMartinezG -

We will have two different endpoints to support this group report

/osm-users/ids/ to retrieve the user IDs for all the OSM usernames supplied
/osm-users/statistics/ - to retrieve statistics for each user

For now we are having the time input filter restricted to one month interval

@ramyaragupathy
Copy link
Member Author

Implemented through #51

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant