Skip to main content
POST
https://api.usedatabrain.com
/
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"
    }
  }'

{
  "status": {
    "progress": "16/16",
    "error": ""
  }
}

​
Endpoint:

POST /datasource/getDatasourceProgress

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
Request Body

​
input
object
required
Input object containing the datasource configuration.
​
input.datasourceId
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"
    }
  }'

​
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.