previewDataSource
POST
/api/v1/data-sources/{provider}/preview
const url = 'https://example.com/api/v1/data-sources/example/preview';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"configuration":{},"previewDate":"2026-04-15"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/data-sources/example/preview \ --header 'Content-Type: application/json' \ --data '{ "configuration": {}, "previewDate": "2026-04-15" }'Requires an authenticated dashboard session. Fetches and parses a candidate Data Source configuration under the safe fetch policy without saving raw data. A previewDate exercises date-aware selection. The provider is a built-in provider or a definition-backed one, and the response shape depends on it.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”provider
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
configuration
required
object
key
additional properties
any
previewDate
string format: date
Examplegenerated
{ "configuration": {}, "previewDate": "2026-04-15"}Responses
Section titled “ Responses ”Sanitized real-data preview and typed diagnostics
Media typeapplication/json
object
data
required
One of:
object
configuration
required
object
displayMode
required
string
maxEvents
required
integer
fields
required
object
title
required
boolean
startTime
required
boolean
endTime
required
boolean
date
required
boolean
location
required
boolean
descriptionExcerpt
required
boolean
timezone
required
string
emptyState
required
string
data
required
object
events
required
Array<object>
object
id
required
string
calendar
required
string
title
required
string
start
required
string format: date-time
end
required
string format: date-time
allDay
required
boolean
location
string
descriptionExcerpt
string
cachedAt
required
string format: date-time
staleAt
required
string format: date-time
usingCachedData
required
boolean
unavailable
required
boolean
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
object
fields
required
Array<object>
object
key
required
string
label
required
string
type
required
string
currency
string
role
string
records
required
Array<object>
object
id
required
string
values
required
object
key
additional properties
string
cachedAt
string format: date-time
staleAt
string format: date-time
usingCachedData
required
boolean
unavailable
required
boolean
dateSelection
object
enabled
required
boolean
dateFormat
required
string
timezone
required
string
mode
required
string
customStartDate
string
customEndDate
string
excludePast
required
boolean
noMatchBehavior
required
string
fallbackText
string
dateField
string
attribution
string
object
datasets
required
Array<object>
object
id
required
string
kind
required
string
fields
Array<object>
object
key
required
string
label
required
string
type
required
string
currency
string
role
string
records
Array<object>
object
id
required
string
values
required
object
key
additional properties
string
points
Array<object>
object
at
required
string format: date-time
values
required
object
key
additional properties
string
values
object
key
additional properties
string
cachedAt
string format: date-time
staleAt
string format: date-time
attribution
string
timezone
string
units
object
key
additional properties
string
usingCachedData
required
boolean
unavailable
required
boolean
object
configuration
required
object
presentation
required
string
fields
required
object
title
required
boolean
subtitle
required
boolean
date
required
boolean
author
required
boolean
description
required
boolean
image
required
boolean
link
required
boolean
emptyState
required
string
dateSelection
required
object
enabled
required
boolean
dateFormat
required
string
timezone
required
string
mode
required
string
customStartDate
string
customEndDate
string
excludePast
required
boolean
noMatchBehavior
required
string
fallbackText
string
data
required
object
records
required
Array<object>
object
id
required
string
title
required
string
subtitle
string
date
string
author
string
description
string
source
string
imageUrl
string
link
string
values
object
key
additional properties
string
cachedAt
required
string format: date-time
staleAt
required
string format: date-time
usingCachedData
required
boolean
unavailable
required
boolean
fieldSchema
Typed fields available to Widgets for these records. Studio uses this schema to build the same typed Data Document that playback receives.
Array<object>
object
key
required
string
label
required
string
type
required
string
currency
string
role
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
Example
{ "data": { "dateSelection": { "dateFormat": "auto", "mode": "today", "noMatchBehavior": "fallback_text" } }}Data Source provider not found
Validation or safe fetch failed