To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1.
HTTP request
GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics
Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of JobMetrics.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-25 UTC."],[[["This webpage details how to request the status of a job using the `projects.locations.jobs.getMetrics` method, which is the recommended approach over using `projects.jobs.getMetrics`."],["The HTTP request for retrieving job metrics is a `GET` request to a specific URL structure: `https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics`."],["Essential path parameters include `projectId`, `location` (the regional endpoint of the job), and `jobId` (the specific job to obtain metrics for)."],["The `startTime` query parameter allows you to filter metric data, returning only changes since the specified timestamp in RFC 3339 format, the default behavior is returning all information about all metrics for the job."],["Authorization for this operation requires one of the following OAuth scopes: `https://www.googleapis.com/auth/compute` or `https://www.googleapis.com/auth/cloud-platform`."]]],[]]
