IMimprovado
Destination connections

Get a connection

Get detailed info about destination connection

get/api/v3/destinations/{destination_name}/connections/{id}

Request

Path parameters

destination_namestring required

Destination name

idinteger required

Destination Connection ID

Response

Get a Connection

idinteger

Connection ID

uidstring

Connection UID

titlestring

Connection title

datasource_namestring

Data source name

statusstring

Connection status

created_atstring

Connection creation date

updated_atstring

Connection update date

accounts_numberinteger

Total number of accounts available on this connection (excluding accounts disabled on the data source side).

enabled_for_extraction_accounts_numberinteger

Number of accounts on this connection that are selected for extraction. Use this to detect connections that have no accounts enabled and prompt the user to select at least one before setting up extractions or loads.

accounts_statusstring

Accounts status

update_accounts_last_successedstring

Last successful accounts update date

update_accounts_was_successfullboolean

Was the last accounts update successful

Example response

{
  "connection": {
    "value": {
      "id": 1,
      "uid": "12345678-1234-5678-1234-567812345678",
      "title": "Connection 1",
      "datasource_name": "google_sheets",
      "status": "active",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "accounts_number": 5,
      "enabled_for_extraction_accounts_number": 3,
      "accounts_status": "active",
      "update_accounts_last_successed": "2021-01-01T00:00:00Z",
      "update_accounts_was_successfull": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.