SDK method

tools.previewSegment

Preview segment reach. Convenience alias for preview_segment, forwarding to tinbox.api.segments.preview.query.

Signature

previewSegment(input: Parameters<TinboxTools["previewSegment"]>[0]): ReturnType<TinboxTools["previewSegment"]>

Parameters

Name	Type	Required	Description
`audienceId`	string	yes	The audience (list) to evaluate against.
`conditions`	object	yes	The (unsaved) condition tree to preview.
`sampleLimit`	number	no	How many sample matches to return (default 5).

Returns

ReturnType<TinboxTools["previewSegment"]>

Example

await tinbox.tools.previewSegment({
  "audienceId": "aud_…",
  "conditions": {
    "match": "all",
    "rules": [
      {
        "field": "<field>",
        "op": "is"
      }
    ]
  }
});