luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

docs for activity log noncontiguous billing period changes (#15882) 

* docs for activity log noncontiguous return changes

* add description of default start and end time to clarify meaning of billing period
This commit is contained in:
Hridoy Roy 2022-06-10 09:27:24 -07:00 committed by GitHub
parent abf65c8a0b
commit 0514503d2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
website/content/api-docs/system/internal-counters.mdx
View File

@ -94,11 +94,17 @@ period, which is represented by the `start_time` and `end_time` parameters.
There are a few things to keep in mind while using this API.
- The activity information only accounts for the activity of the latest
contiguous months in the billing period. For example, if the billing period is
from Jan 2022 to June 2022, and the activity subsystem in Vault was not
capturing data for the months Jan to March, the response will only include
information for May and June.
- For Vault versions before 1.11, the activity information only accounts for
the activity of the latest contiguous months in the billing period.
For example, if the billing period is from Jan 2022 to June 2022, and the
activity subsystem in Vault was not capturing data for the months Jan to March,
the response will only include information for May and June. Note that if no
`start_time` and `end_time` parameters are specified, the billing period defaults
to 12 months, so the endpoint will return activity information from the end of the
previous month to the start of 12 months prior to that date.
- As of 1.11, this behavior has been modified to return all available data within
the specified billing period.
- The response contains the total activity for the billing period and the
attributions of the total activity against specific components in Vault. This