​

Overview

Field Coverage is available in the Dashboard at app.stackone.com/field_coverage

​

Key Features

​

Search Experience

• Search by field and model
• Layer multiple search terms and filters to display the union of all results
• Fuzzy search - find fields and models even with partial or similar names

​

Filters

​

Integration Filters

• Category filters: HRIS, ATS, CRM, LMS, Marketing, Documents, etc.
• Provider filters: Specific integration providers (e.g., BambooHR, Greenhouse, HubSpot)
• Status filters: Active integrations

​

Operation Filters

• List operations: Fields available when listing resources
• Get operations: Fields available when retrieving individual resources
• Create operations: Fields that can be set when creating new resources
• Update operations: Fields that can be modified in existing resources

​

Export Behavior

• CSV export: For spreadsheet analysis and reporting

​

Export Options

1. Full export: All field coverage data across all integrations
2. Filtered export: Only data matching your current filters

​

Key/Legend

​

Operation Indicators

• GET - Green G
• LIST - Blue L
• CREATE - Brown C
• UPDATE - Purple U
• UPSERT - Teal UP

​

Capability Indicators

• Custom fields: Wrench/gear icon indicating custom field support
• Enums: Lowercase ‘e’ icon indicating enum field support
• Required: Red dot in white square indicating required fields
• Conditionally required: Orange dot with red outline indicating conditionally required fields
• Filtering: Filter icon indicating filtering support
• Batch: Refresh/sync icon indicating batch operation support
• Unsupported by Provider: Grey icon with strikethrough indicating unsupported fields

​

Use Cases

​

Evaluating New Connectors

​

Step-by-Step Process

1. Filter for the specific integration
   • Choose the relevant category (HRIS, ATS, CRM, etc.)
   • Use the integration filter to select the connector you’re evaluating
2. Search for specific fields
   • Use the search functionality to find fields critical to your use case
   • Look for both exact matches and similar field names
3. Expand relevant objects/models
   • Click on objects to see their complete field structure
   • Check nested objects and relationships
4. Analyze coverage
   • Review the coverage indicators for each required field
   • Note any limitations or unsupported fields
5. Export results
   • Export the filtered data for stakeholder review
   • Document gaps and workarounds

​

Integration Planning

​

Best Practices

1. Start with core fields
   • Identify the essential fields for your use case
   • Check coverage across multiple potential integrations
2. Compare integrations
   • Use filters to compare field support across different providers
   • Export comparison data for decision-making
3. Plan for gaps
   • Identify unsupported fields early
   • Consider alternative approaches or custom field mapping

​

API Development

​

Development Workflow

1. Research field availability
   • Use field coverage to understand what data is available
   • Plan your data models based on actual field support
2. Handle field variations
   • Use the expand functionality to understand field differences
   • Implement fallback logic for unsupported fields
3. Optimize API calls
   • Use field coverage to determine which fields to request
   • Avoid requesting unsupported fields to improve performance

​

Caveats and Disclaimers

​

Coverage Accuracy

• Dynamic fields: Some integrations support dynamic or custom fields that may not appear in coverage data
• Provider updates: Integration providers may add or modify fields without immediate coverage updates
• Conditional support: Some fields may be available under specific conditions or configurations

​

Limitations

​

Data Freshness

• Field coverage is updated regularly but may lag behind provider changes
• Always verify critical field support through testing or direct API calls

​

Best Practices

1. Verify with testing: Always test critical fields with actual API calls
2. Stay updated: Regularly check field coverage for updates
3. Contact support: Reach out to StackOne support for clarification on specific field support
4. Document findings: Keep records of field support for your specific use cases

​

Getting Help

• Documentation: Check the relevant API Reference for detailed field information
• Support: Contact StackOne support through the dashboard or email (support@stackone.com)