List data connectors
curl --request GET \
--url https://app.chatobserver.com/api/v2/metrics/client/connectors \
--header 'Authorization: Bearer <token>' \
--header 'x-metrics-client-audience: <x-metrics-client-audience>' \
--header 'x-metrics-document-reference: <x-metrics-document-reference>'const options = {
method: 'GET',
headers: {
'x-metrics-client-audience': '<x-metrics-client-audience>',
'x-metrics-document-reference': '<x-metrics-document-reference>',
Authorization: 'Bearer <token>'
}
};
fetch('https://app.chatobserver.com/api/v2/metrics/client/connectors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.chatobserver.com/api/v2/metrics/client/connectors"
headers = {
"x-metrics-client-audience": "<x-metrics-client-audience>",
"x-metrics-document-reference": "<x-metrics-document-reference>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"definition": {
"description": "<string>",
"category": "<string>",
"connectorKey": "<string>",
"displayName": "<string>",
"buildVersion": "<string>",
"documentationUrl": "<string>",
"capabilities": {
"contractVersion": 123,
"connectorKey": "<string>",
"availability": "preview",
"authenticationMethods": [
"basic"
],
"accountDiscovery": "flat",
"catalogDiscovery": "dynamic",
"queryTypes": [
"<string>"
],
"dateSemantics": {
"comparison": false,
"absolute": false,
"relative": false,
"incremental": false,
"timeZone": "provider",
"minimumFreshnessDelayMinutes": 123,
"maximumHistoryDays": 123
},
"pagination": "cursor",
"pushdown": {
"limit": false,
"filters": false,
"comparison": false,
"pivot": false,
"aggregation": false,
"sorting": false,
"pagination": false
},
"rateLimitModel": "none",
"supportedOutputFormats": [
"json"
],
"compatibleDestinationKinds": [
"<string>"
],
"supportsAccountTags": false,
"supportsCustomFields": false,
"supportsMediaFields": false,
"supportsRealtime": false,
"limits": {
"maximumRowsPerRun": 123,
"maximumAccountsPerQuery": 123,
"maximumFieldsPerQuery": 123,
"maximumConcurrentRequests": 123
}
},
"releasedAt": "<string>",
"retiredAt": "<string>"
},
"readiness": {
"connectorKey": "<string>",
"declaredAvailability": "preview",
"selectable": false,
"visible": false,
"platformConfigured": false,
"conformancePassed": false,
"reasonCode": "retired"
},
"presentation": {
"brandDomain": "<string>",
"brandAssetPath": "<string>",
"authenticationMethod": "basic",
"accountModel": "flat",
"connectPath": "<string>",
"setupFields": [
{
"key": "<string>",
"label": "<string>",
"secret": false,
"required": false,
"description": "<string>",
"minLength": 123,
"maxLength": 123,
"placeholder": "<string>",
"format": "email"
}
]
}
}
],
"destinations": [
{
"kind": "sftp",
"label": "<string>",
"description": "<string>",
"brandDomain": "<string>",
"credentialProviderKeys": [
"<string>"
],
"requiredScopes": [
"<string>"
],
"capability": {
"contractVersion": 123,
"availability": "preview",
"authenticationMethods": [
"basic"
],
"limits": {
"maximumRowsPerWrite": 123,
"maximumBytesPerWrite": 123,
"maximumConcurrentWrites": 123
},
"destinationKind": "<string>",
"writeModes": [
"replace"
],
"schemaPolicies": [
"locked"
],
"supportedFormats": [
"ndjson"
],
"supportsTransactions": false,
"supportsAtomicReplace": false,
"supportsPartitioning": false,
"supportsDelete": false,
"supportsTestConnection": false
},
"targetFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"type": "select",
"required": false,
"placeholder": "<string>",
"values": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"internalOnly": false
}
]
}{
"error": {
"code": "internal",
"fieldPath": [
"<string>"
],
"parameters": {},
"repairActions": [
"<string>"
],
"requestId": "<string>",
"retryable": false,
"retryAfterSeconds": 1
}
}Spreadsheet clients
List data connectors
Access document-bound client sessions, queries, schedules, bindings and write claims.
GET
/
api
/
v2
/
metrics
/
client
/
connectors
List data connectors
curl --request GET \
--url https://app.chatobserver.com/api/v2/metrics/client/connectors \
--header 'Authorization: Bearer <token>' \
--header 'x-metrics-client-audience: <x-metrics-client-audience>' \
--header 'x-metrics-document-reference: <x-metrics-document-reference>'const options = {
method: 'GET',
headers: {
'x-metrics-client-audience': '<x-metrics-client-audience>',
'x-metrics-document-reference': '<x-metrics-document-reference>',
Authorization: 'Bearer <token>'
}
};
fetch('https://app.chatobserver.com/api/v2/metrics/client/connectors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.chatobserver.com/api/v2/metrics/client/connectors"
headers = {
"x-metrics-client-audience": "<x-metrics-client-audience>",
"x-metrics-document-reference": "<x-metrics-document-reference>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"definition": {
"description": "<string>",
"category": "<string>",
"connectorKey": "<string>",
"displayName": "<string>",
"buildVersion": "<string>",
"documentationUrl": "<string>",
"capabilities": {
"contractVersion": 123,
"connectorKey": "<string>",
"availability": "preview",
"authenticationMethods": [
"basic"
],
"accountDiscovery": "flat",
"catalogDiscovery": "dynamic",
"queryTypes": [
"<string>"
],
"dateSemantics": {
"comparison": false,
"absolute": false,
"relative": false,
"incremental": false,
"timeZone": "provider",
"minimumFreshnessDelayMinutes": 123,
"maximumHistoryDays": 123
},
"pagination": "cursor",
"pushdown": {
"limit": false,
"filters": false,
"comparison": false,
"pivot": false,
"aggregation": false,
"sorting": false,
"pagination": false
},
"rateLimitModel": "none",
"supportedOutputFormats": [
"json"
],
"compatibleDestinationKinds": [
"<string>"
],
"supportsAccountTags": false,
"supportsCustomFields": false,
"supportsMediaFields": false,
"supportsRealtime": false,
"limits": {
"maximumRowsPerRun": 123,
"maximumAccountsPerQuery": 123,
"maximumFieldsPerQuery": 123,
"maximumConcurrentRequests": 123
}
},
"releasedAt": "<string>",
"retiredAt": "<string>"
},
"readiness": {
"connectorKey": "<string>",
"declaredAvailability": "preview",
"selectable": false,
"visible": false,
"platformConfigured": false,
"conformancePassed": false,
"reasonCode": "retired"
},
"presentation": {
"brandDomain": "<string>",
"brandAssetPath": "<string>",
"authenticationMethod": "basic",
"accountModel": "flat",
"connectPath": "<string>",
"setupFields": [
{
"key": "<string>",
"label": "<string>",
"secret": false,
"required": false,
"description": "<string>",
"minLength": 123,
"maxLength": 123,
"placeholder": "<string>",
"format": "email"
}
]
}
}
],
"destinations": [
{
"kind": "sftp",
"label": "<string>",
"description": "<string>",
"brandDomain": "<string>",
"credentialProviderKeys": [
"<string>"
],
"requiredScopes": [
"<string>"
],
"capability": {
"contractVersion": 123,
"availability": "preview",
"authenticationMethods": [
"basic"
],
"limits": {
"maximumRowsPerWrite": 123,
"maximumBytesPerWrite": 123,
"maximumConcurrentWrites": 123
},
"destinationKind": "<string>",
"writeModes": [
"replace"
],
"schemaPolicies": [
"locked"
],
"supportedFormats": [
"ndjson"
],
"supportsTransactions": false,
"supportsAtomicReplace": false,
"supportsPartitioning": false,
"supportsDelete": false,
"supportsTestConnection": false
},
"targetFields": [
{
"key": "<string>",
"label": "<string>",
"description": "<string>",
"type": "select",
"required": false,
"placeholder": "<string>",
"values": [
{
"value": "<string>",
"label": "<string>"
}
]
}
],
"internalOnly": false
}
]
}{
"error": {
"code": "internal",
"fieldPath": [
"<string>"
],
"parameters": {},
"repairActions": [
"<string>"
],
"requestId": "<string>",
"retryable": false,
"retryAfterSeconds": 1
}
}Required scopes:
client:read.Authorizations
A client session token obtained through the client authorisation challenge flow.
Headers
The audience bound to the authorised client session.
Available options:
chatobserver-metrics-sheets, chatobserver-metrics-excel The document reference hash bound to the client session.
Pattern:
^[a-f0-9]{64}$