curl --request POST \
--url https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"input": {
"datasourceId": "your-datasource-id"
}
}'
const response = await fetch('https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress', {
method: 'POST',
headers: {
'Authorization': 'Bearer dbn_live_abc123...',
'Content-Type': 'application/json'
},
body: JSON.stringify({
input: {
datasourceId: 'your-datasource-id'
}
})
});
const data = await response.json();
console.log('Progress:', data.status.progress);
console.log('Error:', data.status.error);
import requests
response = requests.post(
'https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress',
headers={
'Authorization': 'Bearer dbn_live_abc123...',
'Content-Type': 'application/json'
},
json={
'input': {
'datasourceId': 'your-datasource-id'
}
}
)
data = response.json()
print(f"Progress: {data['status']['progress']}")
print(f"Error: {data['status']['error']}")
{
"status": {
"progress": "16/16",
"error": ""
}
}
Datasource APIs
Get AWSS3 sync Progress status
POST
/
api
/
v2
/
datasource
/
getDatasourceProgress
curl --request POST \
--url https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"input": {
"datasourceId": "your-datasource-id"
}
}'
const response = await fetch('https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress', {
method: 'POST',
headers: {
'Authorization': 'Bearer dbn_live_abc123...',
'Content-Type': 'application/json'
},
body: JSON.stringify({
input: {
datasourceId: 'your-datasource-id'
}
})
});
const data = await response.json();
console.log('Progress:', data.status.progress);
console.log('Error:', data.status.error);
import requests
response = requests.post(
'https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress',
headers={
'Authorization': 'Bearer dbn_live_abc123...',
'Content-Type': 'application/json'
},
json={
'input': {
'datasourceId': 'your-datasource-id'
}
}
)
data = response.json()
print(f"Progress: {data['status']['progress']}")
print(f"Error: {data['status']['error']}")
{
"status": {
"progress": "16/16",
"error": ""
}
}
Endpoint:
POST /datasource/getDatasourceProgress
Headers
Request Body
object
required
Input object containing the datasource configuration.
string
required
The unique identifier of the datasource to check sync progress for.
Request Example
curl --request POST \
--url https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress \
--header 'Authorization: Bearer dbn_live_abc123...' \
--header 'Content-Type: application/json' \
--data '{
"input": {
"datasourceId": "your-datasource-id"
}
}'
const response = await fetch('https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress', {
method: 'POST',
headers: {
'Authorization': 'Bearer dbn_live_abc123...',
'Content-Type': 'application/json'
},
body: JSON.stringify({
input: {
datasourceId: 'your-datasource-id'
}
})
});
const data = await response.json();
console.log('Progress:', data.status.progress);
console.log('Error:', data.status.error);
import requests
response = requests.post(
'https://api.usedatabrain.com/api/v2/datasource/getDatasourceProgress',
headers={
'Authorization': 'Bearer dbn_live_abc123...',
'Content-Type': 'application/json'
},
json={
'input': {
'datasourceId': 'your-datasource-id'
}
}
)
data = response.json()
print(f"Progress: {data['status']['progress']}")
print(f"Error: {data['status']['error']}")
Response Body
{
"status": {
"progress": "16/16",
"error": ""
}
}
Response Body:
Below is a response when no sync is completed for AWSS3:{
"status": {
"progress": "0/...",
"error": ""
}
}
Response Error:
Below is a response error when while syncing AWSS3 throws an error:{
"status": {
"progress": "0/...",
"error": "Error: Bind error data type"
}
}
Error Codes
- INVALID_REQUEST_BODY: The request body is invalid.
- DATASOURCE_ID_ERROR: The datasource ID provided does not exist or is invalid.
⌘I