getDataSource

GET

/api/v1/data-sources/{id}

curl --request GET \
  --url https://example.com/api/v1/data-sources/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Get data source. Requires an authenticated dashboard user.

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Data Source detail including status, diagnostics, cached record count, typed fields, date-selection policy, and Widget and Layout-binding usage

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

provider

required

string

name

required

string

description

required

string

configVersion

required

integer

>= 1

configuration

required

object

key

additional properties

any

creator

object

id

required

string format: uuid

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

required

string

diagnostics

required

object

dataSourceId

required

string format: uuid

lastSuccessfulRefresh

string format: date-time

lastAttemptedRefresh

string format: date-time

httpResultCategory

string

parseStatus

required

string

availableEventCount

required

integer

availableItemCount

required

integer

usingCachedData

required

boolean

cacheUpdatedAt

string format: date-time

cacheExpiresAt

string format: date-time

errorCode

string

fields

required

Array<object>

object

key

required

string

label

required

string

type

required

string

currency

string

role

string

dateSelection

object

enabled

required

boolean

dateFormat

required

string

Allowed values: auto iso_date us_date us_short day_first_date day_first_short day_month_name rfc3339

timezone

required

string

mode

required

string

Allowed values: today tomorrow next_available current_week custom_range

customStartDate

string

customEndDate

string

excludePast

required

boolean

noMatchBehavior

required

string

Allowed values: fallback_text next_available empty hide last_known_good

fallbackText

string

cachedRecordCount

required

integer

widgetUsage

required

Array<object>

object

id

required

string format: uuid

name

required

string

provider

required

string

bindingUsage

required

Array<object>

object

layoutId

required

string format: uuid

layoutName

required

string

field

required

string

Example

{
  "data": {
    "dateSelection": {
      "dateFormat": "auto",
      "mode": "today",
      "noMatchBehavior": "fallback_text"
    }
  }
}

404

Data Source not found