API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Field Extractors

Get Field Extractor

field_extractors.get(strextractor, FieldExtractorGetParams**kwargs) -> FieldExtractorGetResponse

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

Update Field Extractor

field_extractors.update(strextractor, FieldExtractorUpdateParams**kwargs) -> FieldExtractorUpdateResponse

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

Delete Field Extractor

field_extractors.delete(strextractor, FieldExtractorDeleteParams**kwargs) -> object

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

ModelsExpand Collapse

class FieldExtractorGetResponse: …

extractor: str

Extractor type.

rules: List[Rule]

fields: List[RuleField]

expression: str

Wirefilter value expression.

name: str

Field name.

ref: str

Stable rule identifier.

description: Optional[str]

Human-readable rule description.

class FieldExtractorUpdateResponse: …

extractor: str

Extractor type.

rules: List[Rule]

fields: List[RuleField]

expression: str

Wirefilter value expression.

name: str

Field name.

ref: str

Stable rule identifier.

description: Optional[str]

Human-readable rule description.