---
title: "GET /v1/projects/{projectsId}/keys/{keysId}/metrics"
method: GET
path: "/v1/projects/{projectsId}/keys/{keysId}/metrics"
tags: ["projects"]
---

# GET /v1/projects/{projectsId}/keys/{keysId}/metrics

`GET /v1/projects/{projectsId}/keys/{keysId}/metrics`

## Request

- Base URL: `https://recaptchaenterprise.googleapis.com`
- URL: `https://recaptchaenterprise.googleapis.com/v1/projects/{projectsId}/keys/{keysId}/metrics`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/cloud-platform`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`

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

## Path parameters

- `projectsId` string, required
- `keysId` string, required

## Response `200`

Successful response

- GoogleCloudRecaptchaenterpriseV1Metrics: Metrics for a single Key.
  - `challengeMetrics` GoogleCloudRecaptchaenterpriseV1ChallengeMetrics[]: Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.
    - `failedCount` string, int64: Count of submitted challenge solutions that were incorrect or otherwise deemed suspicious such that a subsequent challenge was triggered.
    - `nocaptchaCount` string, int64: Count of nocaptchas (successful verification without a challenge) issued.
    - `pageloadCount` string, int64: Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent to a count of pageloads for pages that include reCAPTCHA.
    - `passedCount` string, int64: Count of nocaptchas (successful verification without a challenge) plus submitted challenge solutions that were correct and resulted in verification.
  - `name` string: Output only. Identifier. The name of the metrics, in the format `projects/{project}/keys/{key}/metrics`.
  - `scoreMetrics` GoogleCloudRecaptchaenterpriseV1ScoreMetrics[]: Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.
    - `actionMetrics` object: Action-based metrics. The map key is the action name which specified by the site owners at time of the "execute" client-side call.
    - `overallMetrics` GoogleCloudRecaptchaenterpriseV1ScoreDistribution: Score distribution.
      - `scoreBuckets` object: Map key is score value multiplied by 100. The scores are discrete values between [0, 1]. The maximum number of buckets is on order of a few dozen, but typically much lower (ie. 10).
  - `startTime` string, google-datetime: Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone.

---

[API](https://skmtc.dev/google/apis/recaptchaenterprise.md) - [All operations](https://skmtc.dev/google/apis/recaptchaenterprise/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/recaptchaenterprise/revisions/26f34c638048?raw)
