---
title: "GET /v1b3/projects/{projectId}/jobs/{jobId}/metrics"
method: GET
path: "/v1b3/projects/{projectId}/jobs/{jobId}/metrics"
tags: ["projects"]
---

# GET /v1b3/projects/{projectId}/jobs/{jobId}/metrics

`GET /v1b3/projects/{projectId}/jobs/{jobId}/metrics`

## Request

- Base URL: `https://dataflow.googleapis.com`
- URL: `https://dataflow.googleapis.com/v1b3/projects/{projectId}/jobs/{jobId}/metrics`
- Auth: one of:
  - 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`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/compute`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/compute`
- TypeScript: <https://skmtc.dev/google/apis/dataflow/docs/v1b3/projects/:projectId/jobs/:jobId/metrics/get.ts> (a function with typed inputs; its response is checked against the schema)

Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. # IAM Permissions Requires the `dataflow.metrics.get` permission on the job.

## Path parameters

- `projectId` string, required
- `jobId` string, required

## Query parameters

- `location` string
- `startTime` string, google-datetime

## Response `200`

Successful response

- JobMetrics: JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. For more information, see [Dataflow job metrics] (https://cloud.google.com/dataflow/docs/guides/using-monitoring-intf). This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
  - `metricTime` string, google-datetime: Timestamp as of which metric values are current.
  - `metrics` MetricUpdate[]: All metrics for this job.
    - `boundedTrie` unknown
    - `cumulative` boolean: True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
    - `distribution` unknown
    - `gauge` unknown
    - `internal` unknown
    - `kind` string: Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
    - `meanCount` unknown
    - `meanSum` unknown
    - `name` MetricStructuredName: Identifies a metric, by describing the source which generated the metric.
      - `context` object: Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] = .
      - `name` string: Worker-defined metric name.
      - `origin` string: Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.
    - `scalar` unknown
    - `set` unknown
    - `trie` unknown
    - `updateTime` string, google-datetime: Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

## Changes

- **2026-10-21** `69a3fb1fef85`: 4 info
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2c`
- **2026-10-15** `e94d44227b2e`: 4 info
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/compute` was removed from the endpoint's security scheme `Oauth2c`
- …earlier changes not shown

[Operation history](https://skmtc.dev/google/apis/dataflow/changes/v1b3/projects/:projectId/jobs/:jobId/metrics/get.md)

---

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