Skip to content
Tilecast Docs

inspectDataSource

POST
/api/v1/data-sources/{provider}/inspect
curl --request POST \
  --url https://example.com/api/v1/data-sources/rss/inspect \
  --header 'Content-Type: application/json' \
  --data '{ "configuration": {} }'

Requires an authenticated dashboard session. Reports the fields a candidate RSS, Atom, JSON, or CSV connection contains, with a few sample values per field, a suggested field mapping, and which record fields the Source can fill. Runs under the same safe fetch policy as preview and deliberately does not require a mapping, because the mapping is what it exists to produce.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
provider
required
string
Allowed values: rss atom feed json csv

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
configuration
required
object
key
additional properties
any
Examplegenerated
{
  "configuration": {}
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Detected fields, sample values, suggested mapping, and available record fields

Media typeapplication/json
object
data
required
object
provider
required
string
fields
required
Array<object>
object
key
required
string
label
required
string
samples
required
Array<string>
type
required
string
Allowed values: text number date datetime url
rowCount
required
integer
delimiter
string
suggested
required
object
rootList
required
string
title
required
string
subtitle
required
string
date
required
string
imageUrl
required
string
link
required
string
valueFields
object
key
additional properties
string
valueFieldTypes
object
key
additional properties
string
Allowed values: text number date datetime url
available
required
object
title
required
boolean
subtitle
required
boolean
date
required
boolean
author
required
boolean
description
required
boolean
image
required
boolean
link
required
boolean
Example
{
  "data": {
    "fields": [
      {
        "type": "text"
      }
    ],
    "suggested": {
      "valueFieldTypes": {
        "additionalProperty": "text"
      }
    }
  }
}

404

Section titled “404”

Provider does not support field detection

422

Section titled “422”

Validation or safe fetch failed