List Transforms

Listing transforms in Nexla allows you to discover, explore, and manage available transformation functions across your platform, enabling you to find the right transforms for your data processing needs and understand their capabilities and usage patterns.

Transform Listing Overview

Transform listing provides comprehensive visibility into your transformation ecosystem, allowing you to browse available transforms, understand their capabilities, and make informed decisions about which transforms to use in your data processing workflows.

Core Listing Capabilities

The transform listing system provides several key capabilities for effective transform discovery and management.

Discovery and Exploration

Find and explore available transforms:

Transform Catalog: Browse comprehensive catalog of available transforms
Search and Filter: Find transforms using various search criteria
Category Browsing: Explore transforms by type and category
Usage Information: Understand transform usage patterns and popularity

Information and Metadata

Access comprehensive transform information:

Transform Details: View detailed transform specifications and configurations
Schema Information: Understand input and output data schemas
Performance Metrics: Access performance and usage statistics
Documentation: Access transform documentation and usage examples

Management and Administration

Manage transform lifecycle and access:

Access Control: Manage transform access permissions and roles
Version Management: Track transform versions and changes
Status Monitoring: Monitor transform status and health
Usage Analytics: Analyze transform usage patterns and trends

List Transforms Endpoint

To retrieve all available transforms:

GET /transforms

Nexla API

List Transforms: Request
GET /transforms

List Transforms Response

A successful request returns all available transforms:

Nexla API

List Transforms: Response
{
  "transforms": [
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "description": "Normalize customer email addresses to lowercase",
      "type": "string",
      "category": "data_quality",
      "status": "ACTIVE",
      "version": "1.0.0",
      "created_at": "2023-01-15T10:00:00.000Z",
      "updated_at": "2023-01-15T10:00:00.000Z",
      "owner": {
        "id": 42,
        "name": "John Doe"
      },
      "usage_count": 15,
      "performance_metrics": {
        "average_execution_time": "0.045s",
        "success_rate": 0.998,
        "error_rate": 0.002
      }
    },
    {
      "id": 6002,
      "name": "Date Formatter",
      "description": "Standardize date formats across datasets",
      "type": "date",
      "category": "formatting",
      "status": "ACTIVE",
      "version": "2.1.0",
      "created_at": "2023-01-14T15:30:00.000Z",
      "updated_at": "2023-01-16T09:15:00.000Z",
      "owner": {
        "id": 42,
        "name": "John Doe"
      },
      "usage_count": 28,
      "performance_metrics": {
        "average_execution_time": "0.032s",
        "success_rate": 0.999,
        "error_rate": 0.001
      }
    },
    {
      "id": 6003,
      "name": "Financial Calculator",
      "description": "Calculate financial metrics and ratios",
      "type": "numeric",
      "category": "business_logic",
      "status": "ACTIVE",
      "version": "1.2.0",
      "created_at": "2023-01-13T12:00:00.000Z",
      "updated_at": "2023-01-15T16:45:00.000Z",
      "owner": {
        "id": 43,
        "name": "Jane Smith"
      },
      "usage_count": 42,
      "performance_metrics": {
        "average_execution_time": "0.078s",
        "success_rate": 0.995,
        "error_rate": 0.005
      }
    }
  ],
  "pagination": {
    "total": 3,
    "page": 1,
    "per_page": 20,
    "total_pages": 1
  },
  "summary": {
    "total_transforms": 3,
    "active_transforms": 3,
    "inactive_transforms": 0,
    "by_type": {
      "string": 1,
      "date": 1,
      "numeric": 1
    },
    "by_category": {
      "data_quality": 1,
      "formatting": 1,
      "business_logic": 1
    }
  }
}

Filtering and Search

Filter and search transforms based on various criteria to find specific transforms.

Filter by Type

Filter transforms by their type:

GET /transforms?type=string
GET /transforms?type=numeric
GET /transforms?type=date

Nexla API

Filter by Type: Response
{
  "transforms": [
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "type": "string",
      "category": "data_quality",
      "status": "ACTIVE",
      "usage_count": 15
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "per_page": 20
  },
  "filters_applied": {
    "type": "string"
  }
}

Filter by Category

Filter transforms by their category:

GET /transforms?category=data_quality
GET /transforms?category=business_logic
GET /transforms?category=formatting

Nexla API

Filter by Category: Response
{
  "transforms": [
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "type": "string",
      "category": "data_quality",
      "status": "ACTIVE",
      "usage_count": 15
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "per_page": 20
  },
  "filters_applied": {
    "category": "data_quality"
  }
}

Search by Name

Search transforms by name or description:

GET /transforms?search=email
GET /transforms?search=financial
GET /transforms?search=date

Nexla API

Search by Name: Response
{
  "transforms": [
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "type": "string",
      "category": "data_quality",
      "status": "ACTIVE",
      "usage_count": 15
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "per_page": 20
  },
  "search_applied": {
    "query": "email",
    "results_count": 1
  }
}

Pagination and Sorting

Control the number and order of transforms returned in your listing.

Pagination

Control the number of transforms returned:

GET /transforms?page=1&per_page=10
GET /transforms?page=2&per_page=20

Nexla API

Pagination: Response
{
  "transforms": [
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "type": "string",
      "category": "data_quality",
      "status": "ACTIVE"
    }
  ],
  "pagination": {
    "total": 25,
    "page": 1,
    "per_page": 10,
    "total_pages": 3,
    "has_next": true,
    "has_previous": false
  }
}

Sorting

Sort transforms by various criteria:

GET /transforms?sort_by=name&sort_order=asc
GET /transforms?sort_by=created_at&sort_order=desc
GET /transforms?sort_by=usage_count&sort_order=desc

Nexla API

Sorting: Response
{
  "transforms": [
    {
      "id": 6003,
      "name": "Financial Calculator",
      "usage_count": 42
    },
    {
      "id": 6002,
      "name": "Date Formatter",
      "usage_count": 28
    },
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "usage_count": 15
    }
  ],
  "sorting_applied": {
    "sort_by": "usage_count",
    "sort_order": "desc"
  }
}

Advanced Filtering

Apply multiple filters and complex criteria to find specific transforms.

Multiple Filters

Combine multiple filter criteria:

GET /transforms?type=string&category=data_quality&status=ACTIVE
GET /transforms?owner_id=42&created_after=2023-01-01

Nexla API

Multiple Filters: Response
{
  "transforms": [
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "type": "string",
      "category": "data_quality",
      "status": "ACTIVE",
      "owner": {
        "id": 42,
        "name": "John Doe"
      }
    }
  ],
  "filters_applied": {
    "type": "string",
    "category": "data_quality",
    "status": "ACTIVE"
  }
}

Status Filtering

Filter transforms by their operational status:

GET /transforms?status=ACTIVE
GET /transforms?status=INACTIVE
GET /transforms?status=DRAFT

Nexla API

Status Filtering: Response
{
  "transforms": [
    {
      "id": 6001,
      "name": "Customer Email Normalizer",
      "status": "ACTIVE"
    },
    {
      "id": 6002,
      "name": "Date Formatter",
      "status": "ACTIVE"
    }
  ],
  "filters_applied": {
    "status": "ACTIVE"
  }
}

Transform Information Fields

Understanding the information fields returned for each transform helps you evaluate their suitability for your needs.

Basic Information

Core transform identification and description:

ID: Unique identifier for the transform
Name: Human-readable transform name
Description: Detailed description of transform functionality
Type: Transform type classification
Category: Business category or domain

Status and Version

Operational status and version information:

Status: Current operational status (ACTIVE, INACTIVE, DRAFT)
Version: Transform version number
Created At: When the transform was created
Updated At: When the transform was last updated

Ownership and Access

Ownership and access control information:

Owner: User who owns the transform
Access Roles: Access permissions and roles
Organization: Organization the transform belongs to
Visibility: Transform visibility settings

Performance and Usage

Performance metrics and usage statistics:

Usage Count: Number of times transform has been used
Average Execution Time: Average processing time
Success Rate: Percentage of successful executions
Error Rate: Percentage of failed executions

CLI Listing

Use the Nexla CLI to list transforms from the command line.

Basic CLI Commands

List transforms using CLI:

nexla transform list
nexla transform list --type string
nexla transform list --category data_quality

Nexla CLI

CLI Listing: Examples
# List all transforms
nexla transform list

# List transforms by type
nexla transform list --type string

# List transforms by category
nexla transform list --category data_quality

# List transforms with search
nexla transform list --search email

# List transforms with pagination
nexla transform list --page 1 --per-page 10

CLI Output Format

CLI output formatting options:

nexla transform list --format json
nexla transform list --format table
nexla transform list --format csv

Nexla CLI

CLI Output Format: Examples
# JSON format output
nexla transform list --format json

# Table format output
nexla transform list --format table

# CSV format output
nexla transform list --format csv --output transforms.csv

Transform Listing Best Practices

To effectively list and discover transforms in your Nexla platform:

Use Appropriate Filters: Apply relevant filters to narrow down results
Leverage Search: Use search functionality to find specific transforms
Understand Fields: Familiarize yourself with transform information fields
Monitor Usage: Track transform usage patterns and performance
Regular Review: Regularly review available transforms for optimization opportunities

Transform Discovery Workflows

Implement structured workflows for effective transform discovery and selection.

Transform Discovery Workflow

Standard workflow for discovering transforms:

Requirements Analysis: Define your transformation requirements
Initial Search: Search for transforms using relevant criteria
Filter Refinement: Apply filters to narrow down results
Transform Evaluation: Evaluate transforms against requirements
Selection: Select appropriate transforms for your needs
Testing: Test selected transforms with your data

Transform Management Workflow

Workflow for managing transform inventory:

Regular Review: Regularly review available transforms
Usage Analysis: Analyze transform usage patterns
Performance Monitoring: Monitor transform performance metrics
Optimization: Identify optimization opportunities
Documentation: Maintain up-to-date transform documentation

Error Handling

Common transform listing issues and solutions:

No Results: Broaden search criteria or check filter settings
Permission Denied: Ensure you have appropriate access permissions
Invalid Filters: Verify filter parameter values and formats
Performance Issues: Use pagination and limit result sets

After listing transforms, you may need to:

View Transform Details

GET /transforms/{transform_id}
GET /transforms/{transform_id}?expand=1

Apply Transforms

POST /transforms/{transform_id}/apply
POST /data/transform

Manage Transforms

PUT /transforms/{transform_id}
DELETE /transforms/{transform_id}

Transform Listing Overview​

Core Listing Capabilities​

Discovery and Exploration​

Information and Metadata​

Management and Administration​

List Transforms Endpoint​

List Transforms Response​

Filtering and Search​

Filter by Type​

Filter by Category​

Search by Name​

Pagination and Sorting​

Pagination​

Sorting​

Advanced Filtering​

Multiple Filters​

Status Filtering​

Transform Information Fields​

Basic Information​

Status and Version​

Ownership and Access​

Performance and Usage​

CLI Listing​

Basic CLI Commands​

CLI Output Format​

Transform Listing Best Practices​

Transform Discovery Workflows​

Transform Discovery Workflow​

Transform Management Workflow​

Error Handling​

Related Operations​

View Transform Details​

Apply Transforms​

Manage Transforms​