---
schema_version: "1"
id: 67033beb684dca1f5795a9f15fde68cf6ae353e14370f3b23e49a1185aa4ba72
title: ConnectionSummary | Tableau Embedding API
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/ConnectionSummary.md
canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/ConnectionSummary.html
source_site: help.tableau.com
content_type: documentation
content_hash: baed1dc2a05fee52eb9f53ece94940704c03d77bd1d94e4cdca58e13374c21c1
description: Documentation for Tableau Embedding API
---
- ConnectionSummary

# Interface ConnectionSummary

Represents a connection within a datasource (ex: A SQL Server connection). A data source can be composed of one or more connections.

interface ConnectionSummary {  
    [id](#id): string;  
    [name](#name): string;  
    [serverURI](#serveruri): undefined | string;  
    [type](#type): string;  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:299

##### Index

### Properties

[id](#id) [name](#name) [serverURI](#serveruri) [type](#type)

## Properties

### `Readonly`id[](#id)

id: string

#### Returns[](#returns)

Unique string representing this connection.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:308

### `Readonly`name[](#name)

name: string

#### Returns[](#returns-1)

The name of the connection (i.e. the caption).

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:303

### `Readonly`serverURI[](#serveruri)

serverURI: undefined | string

#### Returns[](#returns-2)

The URI to which the connection is pointing, if applicable. If a data source is a published data source, the URI is returned as `localhost`.

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:320

### `Readonly`type[](#type)

type: string

#### Returns[](#returns-3)

The type of the connection (i.e. SQL Server, web data connector).

- Defined in packages/api-external-contract-js/src/ExternalContract/Shared/DataSourceInterfaces.ts:313

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Properties

[id](#id)[name](#name)[serverURI](#serveruri)[type](#type)