keys_metrics

Creates, updates, deletes, gets or lists a keys_metrics resource.

Overview

Name	keys_metrics
Type	Resource
Id	google.recaptchaenterprise.keys_metrics

Fields

The following fields are returned by SELECT queries:

get_metrics

Successful response

Name	Datatype	Description
name	string	Output only. Identifier. The name of the metrics, in the format projects/{project}/keys/{key}/metrics.
challengeMetrics	array	Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.
scoreMetrics	array	Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.
startTime	string (google-datetime)	Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_metrics	select	projectsId, keysId		Get some aggregated metrics for a Key. This data can be used to build dashboards.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
keysId	string
projectsId	string

SELECT examples

get_metrics

Get some aggregated metrics for a Key. This data can be used to build dashboards.

SELECT
name,
challengeMetrics,
scoreMetrics,
startTime
FROM google.recaptchaenterprise.keys_metrics
WHERE projectsId = '{{ projectsId }}' -- required
AND keysId = '{{ keysId }}' -- required;