API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Field Extractors

Get Field Extractor

client.fieldExtractors.get(stringextractor, FieldExtractorGetParams { account_id } params, RequestOptionsoptions?): FieldExtractorGetResponse { extractor, rules }

GET/accounts/{account_id}/field_extractors/{extractor}

Update Field Extractor

client.fieldExtractors.update(stringextractor, FieldExtractorUpdateParams { account_id, rules } params, RequestOptionsoptions?): FieldExtractorUpdateResponse { extractor, rules }

PUT/accounts/{account_id}/field_extractors/{extractor}

Delete Field Extractor

client.fieldExtractors.delete(stringextractor, FieldExtractorDeleteParams { account_id } params, RequestOptionsoptions?): FieldExtractorDeleteResponse | null

DELETE/accounts/{account_id}/field_extractors/{extractor}

ModelsExpand Collapse

FieldExtractorGetResponse { extractor, rules }

extractor: string

Extractor type.

rules: Array<Rule>

fields: Array<Field>

expression: string

Wirefilter value expression.

name: string

Field name.

ref: string

Stable rule identifier.

description?: string

Human-readable rule description.

FieldExtractorUpdateResponse { extractor, rules }

extractor: string

Extractor type.

rules: Array<Rule>

fields: Array<Field>

expression: string

Wirefilter value expression.

name: string

Field name.

ref: string

Stable rule identifier.

description?: string

Human-readable rule description.

FieldExtractorDeleteResponse = unknown

Result is null.