From 0514503d2c6b25562a73cb7690cf99a134bbda22 Mon Sep 17 00:00:00 2001 From: Hridoy Roy Date: Fri, 10 Jun 2022 09:27:24 -0700 Subject: [PATCH] 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 --- .../api-docs/system/internal-counters.mdx | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/website/content/api-docs/system/internal-counters.mdx b/website/content/api-docs/system/internal-counters.mdx index 5624d504a..17084c418 100644 --- a/website/content/api-docs/system/internal-counters.mdx +++ b/website/content/api-docs/system/internal-counters.mdx @@ -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