Method: projects.locations.getConfigurablePricingUsageStats

Gets configurable pricing usage stats.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/configurablePricingUsageStats}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the ConfigurablePricingUsageStats to retrieve. Format: projects/{project}/locations/{location}/configurablePricingUsageStats

Query parameters

Parameters
timeRange

object (TimeRange)

Optional. The time range of the usage aggregation. If endDate is not set, it defaults to current date. If startDate is not set, it defaults to 30 days prior to endDate.
metricTypes[]

enum (BillingMetricType)

Optional. The metric types to return usage for.

Request body

The request body must be empty.

Response body

Response for [EstimateBillingService.GetConfigurablePricingUsageStats] method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "name": string,
  "metricUsages": [
    {
      object (MetricUsage)
    }
  ]
}
Fields
name

string

Identifier. The name of the ConfigurablePricingUsageStats. Format: projects/{project}/locations/{location}/configurablePricingUsageStats
metricUsages[]

object (MetricUsage)

A list of metric usages, one for each requested resource type that has data in the requested time range.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

For more information, see the Authentication Overview.

TimeRange

The time range of the usage aggregation.

JSON representation 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Fields
startDate

object (Date)

Optional. The inclusive start date of the usage aggregation.
endDate

object (Date)

Optional. The inclusive end date of the usage aggregation.

BillingMetricType

type of billing metric for usage stats.

Enums
BILLING_METRIC_TYPE_UNSPECIFIED Default value.
DAILY_MDN_QPM Daily median search request QPM.
DAILY_MIN_QPM Daily min search request QPM.
DAILY_MAX_QPM Daily max search request QPM.
DAILY_SEARCH_REQUEST Daily search request total.
TOTAL_STORAGE Total storage bytes for indexing core.

MetricUsage

The usage of a metric over a list of days.

JSON representation 
{
  "metricType": enum (BillingMetricType),
  "datedUsages": [
    {
      object (DatedUsage)
    }
  ],
  "totalUsages": [
    number
  ]
}
Fields
metricType

enum (BillingMetricType)

The metric type.
datedUsages[]

object (DatedUsage)

The list of usages for this resource type, chronologically sorted by date. This is populated for metrics with daily aggregation like DAILY_MDN_QPM.
totalUsages[]

number

The list of total usages for this resource type

DatedUsage

A list of usages for a specific day.

JSON representation 
{
  "date": {
    object (Date)
  },
  "usage": number
}
Fields
date

object (Date)

The date of the usage.
usage

number

The usage value on the date.