getSegmentData()
Returns paginated analyzed entities for the requested target type and filters.
Usage
The following example shows a basic usage of the backend client from @wacht/nextjs/server.
import { wachtClient } from '@wacht/nextjs/server';export async function getUserSegmentData() { const client = await wachtClient(); return client.segments.getSegmentData({ target_type: 'user', filters: { user: { email: '@example.com' }, }, });}Signature
function getSegmentData( request: SegmentDataRequest,): Promise<PaginatedResponse<AnalyzedEntity>>Parameters
›target_type: 'user' | 'organization' | 'workspace';
target_type: 'user' | 'organization' | 'workspace';Entity type to query.
›filters?: SegmentDataFilters | undefined;
filters?: SegmentDataFilters | undefined;Optional per-target filter object.
›segment?: Record<string, unknown> | undefined;
segment?: Record<string, unknown> | undefined;Segment-level filter options.
›ids?: string[] | undefined;
ids?: string[] | undefined;Filter to specific segment ids.
›names?: string[] | undefined;
names?: string[] | undefined;Filter to specific segment names.
›user?: Record<string, unknown> | undefined;
user?: Record<string, unknown> | undefined;User-field filters when `target_type` is `user`.
›email?: string | undefined;
email?: string | undefined;Email/text filter.
›created_at?: Record<string, unknown> | undefined;
created_at?: Record<string, unknown> | undefined;Date-range style filter object.
›from?: string | undefined;
from?: string | undefined;Inclusive range start (ISO-8601).
›to?: string | undefined;
to?: string | undefined;Inclusive range end (ISO-8601).
›organization?: Record<string, unknown> | undefined;
organization?: Record<string, unknown> | undefined;Organization-field filters when `target_type` is `organization`.
›name?: string | undefined;
name?: string | undefined;Organization name/text filter.
›created_at?: Record<string, unknown> | undefined;
created_at?: Record<string, unknown> | undefined;Date-range style filter object.
›from?: string | undefined;
from?: string | undefined;Inclusive range start (ISO-8601).
›to?: string | undefined;
to?: string | undefined;Inclusive range end (ISO-8601).
›workspace?: Record<string, unknown> | undefined;
workspace?: Record<string, unknown> | undefined;Workspace-field filters when `target_type` is `workspace`.
›name?: string | undefined;
name?: string | undefined;Workspace name/text filter.
›created_at?: Record<string, unknown> | undefined;
created_at?: Record<string, unknown> | undefined;Date-range style filter object.
›from?: string | undefined;
from?: string | undefined;Inclusive range start (ISO-8601).
›to?: string | undefined;
to?: string | undefined;Inclusive range end (ISO-8601).
Return value
›data?: AnalyzedEntity[] | undefined;
data?: AnalyzedEntity[] | undefined;Matching entities for this query.
›has_more?: boolean | undefined;
has_more?: boolean | undefined;Whether more results are available.
Behavior
- Fetches a single resource by identifier or query context.
- Use this result as the source of truth before update, replay, or delete flows.