839150 - Create an API endpoint in zamboni

Status: RESOLVED FIXED

(Marketplace Graveyard :: Statistics, defect)

Description

[Andy McKay]

We need an API endpoint to read the stats out of solitude and return them to monolith. 

The endpoint should return a list of stats and allow monolith to paginate through them etc.

The endpoint should allow a deletion of the stats, by id. So monolith can tell us explicitly which ones it has to delete.

It's important that the endpoint is protected by a permission. Since this is not a public api. We should make a permission 'Statistics', 'Collect' or similar.

Comment 1

[Alexis Metaireau (:alexis)]

Monolith will be asking for data that's stored between two dates (start_date and end_date).

I'm not sure we should ask for deletion per id, since it may generate a lot of traffic, rather than that, monolith could be able to ACK the receival and treatment of some data to the API, with the same request it made earlier.

For instance, if I ask for the data between d1 and d2; I can send another request saying to delete the data between these two dates (and not for every item returned). IOW, we want batch deletion here.

For the authentication and the permission, are you thinking about a particular scheme?

Comment 2

[Andy McKay]

I think we should paginate the data between those two dates in case the data gets large.

Agreed we will do the deletion by batch. Could you send all the ids you want to delete in one request? Or the first and last id for example. I'd rather not just use dates as the ranges if possible, I've seen that go wrong a few times :)

Comment 3

[Hanno Schlichting]

EU team talked a bit: We agreed on doing any sort of aggregation / summing up on the monolith side. So the API can export individual records for each download or any other tracked metric.

Comment 4

[Alexis Metaireau (:alexis)]

oops, de-assigning myself. I thought this was for the API on the zamboni side, whereas it's on the solitude side.

Comment 5

[Andy McKay]

I typod in the comment 0. It is zamboni, my mistake.

Comment 6

[Alexis Metaireau (:alexis)]

See https://github.com/ametaireau/zamboni/commit/9464c0ff07c77f0463eee132f9026fc6fe9af219

:andym, r?

Comment 7

[Alexis Metaireau (:alexis)]

updated in https://github.com/ametaireau/zamboni/commit/ba3d227d37f174acda422c2b6dc89d5943dfa417

Comment 8

[Alexis Metaireau (:alexis)]

Fixed in https://github.com/mozilla/zamboni/commit/2c5879f8694735e67a85475173c6787f9aa738fd