update api.json report

[Scott Queen]

Background

api.json https://github.com/18F/analytics-reporter/blob/migrate-ga3-to-ga4/reports/api.json is the source query configuration for building data files that are written to the Postgress database that supports https://open.gsa.gov/api/dap/

User Story

1. 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 api.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 client api successfully
• filtered by the reporter using, --debug, --write-to-database, and --output
• executed by cron.js, or directly at api.sh
• output found in analytics_data_ga4 table
• data can be accessed using our api endpoints with the new updated path that includes /v2/ie, https://api.gsa.gov/analytics/dap/develop/v2/reports/language/data?api_key=DEMO_KEY1&limit=10

includes

• /reports/<report name>/data

**detailed requests availability can be found at https://open.gsa.gov/api/dap/

[Scott Queen]

Browser version is not available https://stackoverflow.com/a/68286131,		Mostly impacts ie, and windows-ie reports

We should consider removing these reports if ie version is no longer accessible

Note: we are already not including in the updated MVP https://analytics-develop.app.cloud.gov/data/

[Scott Queen]

hasSocialSourceReferral is not available	Was a yes no value	impacts traffic-source report

we have an option to relace with sessionDefaultChannelGroup, this provides the referral type

defaultChannelGroup	Default channel group	The conversion's default channel group is based primarily on source and medium. An enumeration which includes Direct, Organic Search, Paid Social, Organic Social, Email, Affiliates, Referral, Paid Search, Video, and Display.

report values look like this

[Marina Fox, TTS, GSA]

remove from the API

[Scott Queen]

@smarina04 For testing our reports schema we can review several points of changes to integration.

Review changes to api.json
https://github.com/18F/analytics-reporter/pull/726/files#diff-3d01cc079add8f7082bf80461898810abd7e6d48aae4bf6b04c8f9ef9319ffb7

Try API requests for any report names listed in api.json at /reports/<report name>/data

ie.

v1.1
https://api.gsa.gov/analytics/dap/develop/v1.1/reports/language/data?api_key=DEMO_KEY1

v2
https://api.gsa.gov/analytics/dap/develop/v2/reports/language/data?api_key=DEMO_KEY1

If you find any issues or concerns that would impact the MVP work with these query update(s), please leave as comment in this ticket.