Retrieve a list of links connected to a specific asset. Links represent the data flow betweensource(upstream) andtarget(downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them.
You can retrieve links in every project where you have thedatalineage.events.getpermission. The project provided in the URL is used for Billing and Quota.
HTTP request
POST https://datalineage.googleapis.com/v1/{parent}:searchLinks
Path parameters
Parameters
parent
string
Required. The project and location you want search in. It takes the formprojects/{project}/locations/{location}.
Request body
The request body contains data with the following structure:
JSON representation
{"pageSize":integer,"pageToken":string,// Union fieldcriteriacan be only one of the following:"source":{object (EntityReference)},"target":{object (EntityReference)}// End of list of possible types for union fieldcriteria.}
Fields
pageSize
integer
Optional. The maximum number of links to return in a single page of the response. A page may contain fewer links than this value. If unspecified, at most 10 links are returned.
Maximum value is 100; values greater than 100 are reduced to 100.
pageToken
string
Optional. The page token received from a previousSearchLinksRequestcall. Use it to get the next page.
When requesting subsequent pages of a response, remember that all parameters must match the values you provided in the original request.
Union fieldcriteria. The asset for which you want to retrieve links.criteriacan be only one of the following:
The start of the first event establishing this link.
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".
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".
[[["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 outlines how to retrieve links between assets, which represent data flow in transformation pipelines, using the \u003ccode\u003esearchLinks\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esearchLinks\u003c/code\u003e method uses a POST request to the endpoint \u003ccode\u003ehttps://datalineage.googleapis.com/v1/{parent}:searchLinks\u003c/code\u003e, where \u003ccode\u003eparent\u003c/code\u003e specifies the project and location.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain criteria for the desired asset, including optional \u003ccode\u003esource\u003c/code\u003e or \u003ccode\u003etarget\u003c/code\u003e fields, along with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e for handling large result sets.\u003c/p\u003e\n"],["\u003cp\u003eTo successfully use the method, you need the \u003ccode\u003edatalineage.events.get\u003c/code\u003e permission on the project and \u003ccode\u003edatalineage.locations.searchLinks\u003c/code\u003e on the parent resource, alongside the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eThe response contains a list of links with details about the data flow, including \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003esource\u003c/code\u003e, \u003ccode\u003etarget\u003c/code\u003e, \u003ccode\u003estartTime\u003c/code\u003e, and \u003ccode\u003eendTime\u003c/code\u003e, alongside a \u003ccode\u003enextPageToken\u003c/code\u003e for navigating additional pages of results.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.searchLinks\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchLinksResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Link](#Link)\n - [JSON representation](#Link.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nRetrieve a list of links connected to a specific asset. Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them.\n\nYou can retrieve links in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota.\n\n### HTTP request\n\n`POST https://datalineage.googleapis.com/v1/{parent}:searchLinks`\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nResponse message for [locations.searchLinks](/dataplex/docs/reference/data-lineage/rest/v1/projects.locations/searchLinks#google.cloud.datacatalog.lineage.v1.Lineage.SearchLinks).\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\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 `parent` resource:\n\n- `datalineage.locations.searchLinks`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nLink\n----\n\nLinks represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines.\n\nLinks are created when LineageEvents record data transformation between related assets."]]
