Opened 5 years ago

Closed 15 months ago

#15324 closed enhancement (wontfix)

Document the API to access the reports stored on the OONI pipeline

Reported by: hellais Owned by: hellais
Priority: Medium Milestone:
Component: Archived/Ooni Version:
Severity: Normal Keywords: archived-closed-2018-07-04
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

We have a pipeline, in there is some data. People will want to query this database for the data they are interested in.

It should be documented how they can do so similarly to how the oonib HTTP API is documented.

This text should then be stored inside of ooni-spec and kept up to date.

Child Tickets

Change History (4)

comment:1 Changed 4 years ago by aagbsn

I would like to be able to request reports sorted by date-created, and with the ability to filter queried results by specific date ranges.

comment:2 Changed 4 years ago by hellais

This query will give you all the reports collected ever (sorted by date):

http://api.ooni.io/api/reports/headers?fields=probe_cc&fields=start_time&fields=test_name&fields=probe_asn&fields=report_id&limit=0

You can then filter in your client for the date range you are interested in.

To add support for filtering by date you should look at this code and perhaps add an extra argument called date_interval:
https://github.com/TheTorProject/ooni-api/blob/master/common/models/report.js

comment:3 Changed 22 months ago by teor

Severity: Normal

Set all open tickets without a severity to "Normal"

comment:4 Changed 15 months ago by teor

Keywords: archived-closed-2018-07-04 added
Resolution: wontfix
Status: newclosed

Close all tickets in archived components

Note: See TracTickets for help on using tickets.