Skip to content

Commit

Permalink
Updating README with new API information
Browse files Browse the repository at this point in the history
nathan-moore-97 committed Oct 26, 2023
1 parent 27357cb commit 73e83c4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -101,6 +101,26 @@ Request body:
}
```

#### Product Analytics Bulk Upload
Exports Google Analytics data gathered from the IDVA flow to Google Drive, as a google sheets object. Routine then builds pivot tables to enable user to read data easily. Default behaviour for the API `/analytics` writes data for the previous day.

The ID of the Google Drive folder is configurable in `ANALYTICS_ROOT`. (`settings`)

Optionally, the user can pass in a date range to be uploaded. The data is collated into a single document, and the same pivot tables are written on the collated data.

`POST /analytics`
```
Query parameters: None
```
`POST /analytics/daterange`
```JSON
// Request body
{
"startDate": "YYYY-MM-DD",
"endDate": "YYYY-MM-DD"
}
```


### Deploying to Cloud.gov during development
All deployments require having the correct Cloud.gov credentials in place. If

0 comments on commit 73e83c4

Please sign in to comment.