enrich

Preview of a generic HTTP enrichment

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

post/enrich/user-defined-http/{handle}/preview

Request

Base URL
//api.gigasheet.com (relative, and the document’s source URL is not known)
Auth
API key in header X-GIGASHEET-TOKEN
TypeScript
https://skmtc.dev/freshdesk/apis/gigasheet-api/docs/enrich/user-defined-http/:handle/preview/post.ts
A function with typed inputs. Its response is checked against the schema.

handlestring required

sheet ID

LaxValidationboolean

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

body_escape_format'json' | 'none'

body_templatestring

Request body template string (with column id placeholders)

email_on_completionstring[]

List of email addresses to notify on completion

filter_modelobject

Filter model to apply

headersHttpHeader

maximum_requests_per_secondnumber

Maximum number of requests per second

methodstring

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

recipe_idstring

Gigasheet recipe ID (optional)

response_type'json' | 'raw' | 'unknown'

url_templatestring

URL template string (with column id placeholders)

execution_msinteger

response_type'json' | 'raw' | 'unknown'

successboolean

No recorded changes to this operation across all 1 revision of this API.