Preview of a generic HTTP enrichment

post https://api.gigasheet.com/enrich/user-defined-http/{handle}/preview

Returns a preview of the generic HTTP enrichment based on provided request parameters.

Path Params

handle

string

required

sheet ID

Body Params

enrichment settings

LaxValidation

boolean

internal only, skips live DNS validation steps to allow testing against local server

body_escape_format

string

One of 'json', 'none'. Default 'none'.

body_template

string

Request body template string (with column id placeholders)

bulk

object

Bulk configuration

columns

array of objects

Columns with data used in enrichment requests

columns

email_on_completion

array of strings

List of email addresses to notify on completion

email_on_completion

filter_model

object

Filter model to apply

headers

object

HTTP headers

maximum_requests_per_second

number

Maximum number of requests per second

method

string

http request method. 'GET', 'POST', 'PUT', 'PATCH'.

output_path_map

array of objects

Mapping of output to column

output_path_map

recipe_id

string

Gigasheet recipe ID (optional)

response_type

string

One of 'json', 'raw', 'unknown'. Default 'json'.

retry_properties

object

Retry configuration

sort_model

array of objects

Sort models to apply

sort_model

url_template

string

URL template string (with column id placeholders)

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.gigasheet.com/enrich/user-defined-http/handle/preview \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

500Internal Server Error