update usa.json report
scottqueen-bixal opened this issue · comments
Background
usa.json
https://github.com/18F/analytics-reporter/blob/master/reports/usa.json is the source query configuration for building data files that are written to the s3 that supports https://analytics.usa.gov/
User Story
- As a developer running reports using the analytics-reporter application, I want to find the query schema that is passed to the Google Data API client requests in the report file
usa.json
.
This schema should follow the following structure:
...
{
"name": STRING,
"frequency": STRING (one of realtime, daily, hourly,
"realtime": BOOLEAN,
"query": {
"dimensions": [ OBJECT(S) ],
"metrics":[ OBJECT(S) ],
"dateRanges": [
{
"startDate": STRING,
"endDate": STRING
}
],
"orderBys": [
{
"metric": {
"metricName": STRING
},
"desc": BOOLEAN
}
],
"dimensionFilter": {
"filter": {
"fieldName": STRING,
"stringFilter": {
"value": STRING
}
}
},
"metricFilter": {
"filter": {
"fieldName": STRING,
"numericFilter": {
"operation": STRING,
"value": {
"int64Value": STRING
}
}
}
}
},
"meta": {
"name": STRING,
"description": STRING
}
},
...
Acceptance Criteria
Query can be:
- requested to the api successfully
- filtered by the reporter using,
--frequency
,--only
, and--output
- executed by
cron.js
,daily.sh
,hourly.sh
, andrealtime.sh
- output found in JSON or CSV format in the
s3://
directory
@smarina04 For testing our reports schema we can review several points of changes to integration.
1.) Review changes to usa.json
https://github.com/18F/analytics-reporter/pull/726/files#diff-5dd56d67e9094d6411524af02ade99bfdc5a87cff6b7066f43339cb198a8af5fR5
You should be able to prepend https://analytics-develop.app.cloud.gov/
to the report "name" included,
ie, "name ": "realtime"
at data/live/realtime.json
2.) We also create agency reports based on usa.json
- Confirming access to the generated reports included in this files.csv
Each of the participating agencies
You should be able to prepend https://analytics-develop.app.cloud.gov/
to the paths included ie, data/agency-international-development/realtime.json