Authorization requires the following IAM permission on the specified resource name:
dataform.workspaces.fetchGitAheadBehind
Query parameters
Parameters
remoteBranch
string
Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.
Request body
The request body must be empty.
Response body
workspaces.fetchGitAheadBehind response message.
If successful, the response body contains data with the following structure:
[[["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-07-21 UTC."],[[["\u003cp\u003eThis document describes how to fetch Git ahead/behind information for a workspace against a remote branch using an HTTP GET request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003ename\u003c/code\u003e path parameter specifying the workspace and an optional \u003ccode\u003eremoteBranch\u003c/code\u003e query parameter to compare against a specific branch.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes the number of commits ahead of the remote branch (\u003ccode\u003ecommitsAhead\u003c/code\u003e) and the number of commits behind the remote branch (\u003ccode\u003ecommitsBehind\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eAccess to this resource requires the \u003ccode\u003edataform.workspaces.fetchGitAheadBehind\u003c/code\u003e IAM permission and one of the specified OAuth scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe request body is empty, and the response is a JSON object containing the \u003ccode\u003ecommitsAhead\u003c/code\u003e and \u003ccode\u003ecommitsBehind\u003c/code\u003e integer values.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.repositories.workspaces.fetchGitAheadBehind\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.FetchGitAheadBehindResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nFetches Git ahead/behind against a remote branch.\n\n### HTTP request\n\n`GET https://dataform.googleapis.com/v1/{name=projects/*/locations/*/repositories/*/workspaces/*}:fetchGitAheadBehind`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\n`workspaces.fetchGitAheadBehind` response message.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/bigquery`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `dataform.workspaces.fetchGitAheadBehind`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
