inspectDataSource

POST

/api/v1/data-sources/{provider}/inspect

const url = 'https://example.com/api/v1/data-sources/rss/inspect';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"configuration":{}}'
};

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/rss/inspect \
  --header 'Content-Type: application/json' \
  --data '{ "configuration": {} }'

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

Path Parameters

provider

required

Allowed values: rss atom json csv

Request Body^required

application/json

object

configuration

required

object

Example^generated

{
  "configuration": {}
}

Responses

200

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

404

Provider does not support field detection

422

Validation or safe fetch failed