Skip to main content

List Nexsets

Listing Nexsets in Nexla allows you to view and manage all your data processing workflows, enabling you to monitor performance, track configurations, and maintain your data transformation infrastructure.

Nexset Listing Overview​

The Nexset listing system provides comprehensive access to all your data processing workflows, allowing you to monitor their status, performance, and configuration while maintaining organized management of your transformation infrastructure.

List All Nexsets​

Retrieve all Nexsets to get a comprehensive view of your data processing workflows.

Basic Listing Endpoint​

To retrieve all your Nexsets:

GET /nexsets
List All Nexsets: Request
GET /nexsets

Response Structure​

The response includes comprehensive Nexset information with all relevant details:

List All Nexsets: Response
[
  {
    "id": 3001,
    "name": "Customer Data Enrichment",
    "description": "Enrich customer data with demographic and behavioral information",
    "input_schema_id": 2001,
    "output_schema_id": 2002,
    "transforms": [3001, 3002],
    "config": {
      "processing_mode": "streaming",
      "batch_size": 1000,
      "error_handling": "continue_on_error"
    },
    "status": "ACTIVE",
    "created_at": "2023-01-15T10:00:00.000Z",
    "updated_at": "2023-01-15T10:00:00.000Z",
    "owner": {
      "id": 42,
      "full_name": "John Smith"
    },
    "metrics": {
      "records_processed": 1500000,
      "processing_rate": 2500,
      "error_rate": 0.02
    }
  },
  {
    "id": 3002,
    "name": "Transaction Aggregation",
    "description": "Aggregate transaction data for reporting and analytics",
    "input_schema_id": 2003,
    "output_schema_id": 2004,
    "transforms": [3003, 3004],
    "config": {
      "processing_mode": "batch",
      "batch_size": 5000,
      "error_handling": "stop_on_error"
    },
    "status": "ACTIVE",
    "created_at": "2023-01-16T14:30:00.000Z",
    "updated_at": "2023-01-16T14:30:00.000Z",
    "owner": {
      "id": 42,
      "full_name": "John Smith"
    },
    "metrics": {
      "records_processed": 850000,
      "processing_rate": 1800,
      "error_rate": 0.01
    }
  }
]

Filtering Nexsets​

Use advanced filtering to focus on specific types of Nexsets and workflows.

Filter by Status​

Filter Nexsets by their operational status:

Filter by Status: Request
GET /nexsets?status=ACTIVE

Filter by Owner​

Filter Nexsets by specific owners:

Filter by Owner: Request
GET /nexsets?owner_id=42

Filter by Processing Mode​

Filter Nexsets by processing mode:

Filter by Processing Mode: Request
GET /nexsets?processing_mode=streaming

Filter by Schema​

Filter Nexsets by input or output schema:

Filter by Schema: Request
GET /nexsets?input_schema_id=2001

Combined Filtering​

Combine multiple filters for precise Nexset targeting:

Combined Filtering: Request
GET /nexsets?status=ACTIVE&processing_mode=streaming&owner_id=42

Time-Based Filtering​

Filter Nexsets by creation or update time to focus on recent or historical workflows.

Filter by Creation Date​

Filter Nexsets created within specific time periods:

Filter by Creation Date: Request
GET /nexsets?created_after=2023-01-01T00:00:00&created_before=2023-01-31T23:59:59

Filter by Update Date​

Filter Nexsets updated within specific time periods:

Filter by Update Date: Request
GET /nexsets?updated_after=2023-01-15T00:00:00

Pagination and Sorting​

Manage large numbers of Nexsets efficiently with pagination and sorting.

Pagination​

Use pagination to handle large Nexset collections:

Pagination: Request
GET /nexsets?page=1&per_page=50

Sorting Options​

Sort Nexsets by various criteria for better organization:

Sorting: Request
GET /nexsets?sort_by=created_at&sort_order=DESC

Available Sort Fields​

Sort Nexsets by various attributes:

  • created_at: Sort by Nexset creation time
  • updated_at: Sort by last update time
  • name: Sort by Nexset name
  • status: Sort by operational status
  • owner_id: Sort by owner

Search Functionality​

Find specific Nexsets quickly using search capabilities.

Text Search​

Search Nexsets by name and description content:

Text Search: Request
GET /nexsets?search=enrichment

Combine search with other filters for precise results:

Advanced Search: Request
GET /nexsets?search=customer&status=ACTIVE&processing_mode=streaming

Nexset Response Fields​

Understanding the Nexset response structure helps you effectively process and manage your data processing workflows.

Basic Information​

Essential Nexset identification and metadata:

  • id: Unique Nexset identifier
  • name: Human-readable Nexset name
  • description: Detailed description of the Nexset
  • status: Current operational status (ACTIVE, INACTIVE, ERROR)
  • created_at: When the Nexset was created
  • updated_at: When the Nexset was last updated

Schema Information​

Details about data structure and processing:

  • input_schema_id: ID of the input data schema
  • output_schema_id: ID of the output data schema
  • transforms: Array of transform IDs applied to data

Configuration Information​

Processing configuration and parameters:

  • config: Processing configuration object
  • processing_mode: Data processing mode (streaming, batch, hybrid)
  • batch_size: Number of records processed per batch
  • error_handling: Error handling behavior configuration

Performance Metrics​

Operational performance and statistics:

  • metrics: Performance metrics object
  • records_processed: Total number of records processed
  • processing_rate: Records processed per second
  • error_rate: Percentage of records with processing errors

Filtering and Search Parameters​

Available query parameters for filtering and searching Nexsets.

Status Parameters​

Filter by Nexset status:

  • status: Filter by operational status (ACTIVE, INACTIVE, ERROR)

Owner Parameters​

Filter by Nexset ownership:

  • owner_id: Filter by specific owner ID

Processing Parameters​

Filter by processing characteristics:

  • processing_mode: Filter by processing mode (streaming, batch, hybrid)

Schema Parameters​

Filter by schema characteristics:

  • input_schema_id: Filter by input schema ID
  • output_schema_id: Filter by output schema ID

Time Parameters​

Filter by time ranges:

  • created_after: Filter by creation time (ISO 8601 format)
  • created_before: Filter by creation time (ISO 8601 format)
  • updated_after: Filter by update time (ISO 8601 format)
  • updated_before: Filter by update time (ISO 8601 format)

Pagination Parameters​

Control result pagination:

  • page: Page number (default: 1)
  • per_page: Results per page (default: 20, max: 100)

Sorting Parameters​

Control result ordering:

  • sort_by: Field to sort by (default: created_at)
  • sort_order: Sort direction (ASC or DESC, default: DESC)

Search Parameters​

Text search capabilities:

  • search: Search term for name and description content

CLI Nexset Listing​

Use the Nexla CLI to list Nexsets for efficient command-line management.

CLI Command Structure​

Basic CLI command for listing Nexsets:

nexla nexset list [options]

CLI Options​

Available CLI options for Nexset listing:

  • --status: Filter by status
  • --owner: Filter by owner
  • --mode: Filter by processing mode
  • --format: Output format (json, table, csv)

CLI Examples​

Common CLI usage patterns for Nexset listing:

CLI Nexset Listing: Examples
# List all Nexsets
nexla nexset list

# List active Nexsets
nexla nexset list --status active

# List Nexsets by owner
nexla nexset list --owner 42

# List streaming Nexsets
nexla nexset list --mode streaming

Nexset Listing Use Cases​

Nexset listing serves various operational and management purposes.

Operational Monitoring​

Monitor Nexset operations and performance:

  • Status Monitoring: Track operational status of all Nexsets
  • Performance Tracking: Monitor processing performance and metrics
  • Error Detection: Identify Nexsets with processing issues
  • Resource Management: Manage processing resources and capacity

Configuration Management​

Manage Nexset configurations and settings:

  • Configuration Review: Review current configuration settings
  • Change Tracking: Track configuration changes over time
  • Version Management: Manage different configuration versions
  • Deployment Management: Manage configuration deployments

Development and Testing​

Support development and testing activities:

  • Development Tracking: Track Nexsets in development
  • Testing Management: Manage testing configurations
  • Deployment Planning: Plan production deployments
  • Rollback Planning: Plan configuration rollbacks

Nexset Listing Best Practices​

To effectively list and manage Nexsets:

  1. Use Appropriate Filters: Apply filters to focus on relevant Nexsets
  2. Implement Pagination: Use pagination for large Nexset collections
  3. Regular Monitoring: Periodically review Nexset status and performance
  4. Search Efficiently: Use search to find specific Nexsets quickly
  5. Monitor Trends: Analyze Nexset patterns for optimization

Error Handling​

Common Nexset listing issues and solutions:

  • Permission Denied: Ensure you have appropriate access rights
  • Invalid Parameters: Verify query parameters are correctly formatted
  • Resource Not Found: Confirm the specified resources exist
  • Pagination Issues: Check page and per_page parameter values

After listing Nexsets, you may need to:

View Nexset Details​

GET /nexsets/{nexset_id}

Update Nexset Configuration​

PUT /nexsets/{nexset_id}
PUT /nexsets/{nexset_id}/config

Monitor Nexset Performance​

GET /nexsets/{nexset_id}/metrics
GET /nexsets/{nexset_id}/status

Control Nexset Operations​

PUT /nexsets/{nexset_id}/activate
PUT /nexsets/{nexset_id}/pause