Test a BigQuery connection

Learn more about testing a BigQuery connection configured in Reltio.

The Test BigQuery connection verifies that Reltio obtains short-lived credentials through service account impersonation. It also runs a lightweight query in the configured BigQuery project.

Note: This operation returns HTTP 200 OK for both successful and unsuccessful connection tests. Use the result.connected field in the response body to determine the actual result.

HTTP method and endpoint

Use the following HTTP method and endpoint path to test the BigQuery connection.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/{connectionName}/test

The following table describes the endpoint path parameters.


Parameter	Type	Required	Description
`tenantId`	String	Yes	Identifier of the tenant where the BigQuery connection is defined. Example: `ce5627DYnQ6abcD`
`connectionName`	String	Yes	Name of the saved BigQuery connection that you want to test.

Request headers

The following request headers must be included.


Header	Value	Required
`Authorization`	Bearer `<access_token>`	Yes
`Content-Type`	application/json	Yes

Request body

This operation does not require a request body.

Example request

Use the following example to test the BigQuery connection configuration.

POST {platformUrl}/reltio/api/tenants/{tenantId}/interactions/database-configs/{connectionName}/test

Response body

The following table describes the response fields returned by this operation.


Field	Type	Description
`successful`	Boolean	Indicates whether the API processed the connection test request.
`result.connected`	Boolean	Indicates whether the BigQuery connection test succeeded.
`result.databaseType`	String	Database type of the tested connection. The value is `BIGQUERY`.
`result.message`	String	Message describing the connection test result.

Example response

Use the following example to see how a complete request is structured when the connection test succeeds.

{
  "successful": true,
  "result": {
    "connected": true,
    "databaseType": "BIGQUERY",
    "message": "Connection successful"
  }
}

If the connection test fails, the response is similar to the following example.

{
  "successful": true,
  "result": {
    "connected": false,
    "databaseType": "BIGQUERY",
    "message": "Connection failed: the Reltio service account cannot impersonate the customer service account"
  }
}

To resolve a failed connection test:

Review result.message.
Update the connection values in Create a BigQuery connection, or correct the IAM grants
Test the connection again.

Unify and manage your data