Preview an existing data feed

POST

/api/v3/curations/data-feeds/{feedUniqueId}/preview

curl --request POST \
  --url 'https://api.tryletterhead.com/api/v3/curations/data-feeds/example/preview?api=true' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "feedUrl": "example", "bearerToken": "example" }'

• Production

Same as Preview a data feed URL, for a feed that’s already been created — still requires feedUrl (typically the feed’s current URL, or a new one you’re testing before saving an update). Leave bearerToken blank to test with the credential already stored on the feed instead of fetching unauthenticated.

Authorizations

• bearerAuth

Parameters

Path Parameters

feedUniqueId

required

string

The data feed’s unique identifier, from List data feeds.

Query Parameters

api

required

boolean

Required. Set to true to authenticate with your company API key rather than a signed-in session.

Request Body ^required

Media type application/json

object

feedUrl

required

string

bearerToken

Plaintext, used only for this one test fetch. Blank means test with the feed’s already-stored credential.

string

Example ^generated

{
  "feedUrl": "example",
  "bearerToken": "example"
}

Responses

200

200 OK

Media type application/json

object

items

object

itemCount

integer

fields

Array<object>

object

path

string

sample

string

message

string

total

integer

Example ^generated

{
  "items": {
    "itemCount": 1,
    "fields": [
      {
        "path": "example",
        "sample": "example"
      }
    ]
  },
  "message": "example",
  "total": 1
}