Skip to main content

Coda Data Source

The Coda connector enables you to ingest data from your Coda documents, including tables, rows, pages, formulas, controls, and analytics. This connector is particularly useful for applications that need to extract structured data from Coda docs, sync Coda data to other systems, or analyze document usage metrics.
coda_api.png

Coda

Follow the instructions below to create a new data flow that ingests data from a Coda source in Nexla.

Create a New Data Flow

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Coda connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Coda instance, and click Next; or, create a new Coda credential for use in this flow.

  3. In Nexla, Coda data sources can be created using pre-built endpoint templates, which expedite source setup for common Coda endpoints. Each template is designed specifically for the corresponding Coda endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Coda sources can also be configured manually, allowing you to ingest data from Coda endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Coda endpoints. Each template is designed specifically for the corresponding Coda endpoint, making data source setup easy and efficient.

Endpoint Settings

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List Documents

    This endpoint retrieves a list of all Coda documents accessible by the authenticated user. Use this endpoint when you need to discover available documents, monitor document metadata, or build dynamic workflows that operate on multiple documents.

    • This endpoint automatically retrieves all documents accessible to your Coda account. No additional configuration is required beyond selecting this endpoint template.
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format (e.g., 0 6 * * * for daily at 6 AM).
    • The endpoint uses pagination to handle large numbers of documents efficiently, automatically fetching additional pages as needed using the nextPageToken parameter.
    • Each document record includes metadata such as document name, ID, creation date, and owner information.

    This endpoint is useful for discovering available documents before configuring more specific endpoints. The returned data includes document IDs that can be used as input for other Coda endpoints. For complete information about listing documents, see the Coda List Docs API Documentation.

    Get Document Details

    This endpoint retrieves detailed metadata for a specific Coda document. Use this endpoint when you need document information, permissions, or configuration details for a particular document.

    • Enter the Document ID in the Document ID field. You can find this ID by first using the "List Documents" endpoint to retrieve available documents and their corresponding IDs. Document IDs are typically found in the document URL or can be obtained from the document's share settings.
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint returns document metadata including name, description, creation date, owner, and permission settings.

    Document IDs are unique identifiers for each Coda document. You can find the document ID in the document URL (e.g., https://coda.io/d/{docId}) or by using the "List Documents" endpoint. For complete information about getting document details, see the Coda Get Doc API Documentation.

    List Pages

    This endpoint retrieves a list of pages within a specific Coda document. Use this endpoint when you need to discover available pages, analyze document structure, or build workflows that operate on multiple pages.

    • Enter the Document ID in the Document ID field. This should match the exact ID of a document in your Coda account.
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint uses pagination to handle documents with large numbers of pages efficiently, automatically fetching additional pages as needed.
    • Each page record includes metadata such as page name, ID, and position within the document.

    This endpoint is useful for discovering available pages before configuring endpoints that operate on specific pages. The returned data includes page IDs that can be used as input for other Coda endpoints. For complete information about listing pages, see the Coda List Pages API Documentation.

    List Tables

    This endpoint retrieves a list of tables within a specific Coda document. Use this endpoint when you need to discover available tables, analyze document structure, or build workflows that operate on multiple tables.

    • Enter the Document ID in the Document ID field. This should match the exact ID of a document in your Coda account.
    • Optionally, select a sort order from the Sort By field. Available options are "Default" (natural order) or "Name" (alphabetical by name).
    • Optionally, select table types to include from the Table Types field. Available options are "All" (both tables and views), "Tables Only" (base tables), or "Views Only" (views). The default is "All".
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint uses pagination to handle documents with large numbers of tables efficiently, automatically fetching additional pages as needed.

    This endpoint is useful for discovering available tables before configuring endpoints that operate on specific tables. The returned data includes table IDs that can be used as input for other Coda endpoints. For complete information about listing tables, see the Coda List Tables API Documentation.

    List Columns

    This endpoint retrieves a list of columns within a specific table in a Coda document. Use this endpoint when you need to discover table structure, analyze column metadata, or build workflows that reference specific columns.

    • Enter the Document ID in the Document ID field. This should match the exact ID of a document in your Coda account.
    • Enter the Table ID in the Table ID field. You can find this ID by using the "List Tables" endpoint to retrieve available tables and their corresponding IDs.
    • Optionally, check the Visible Only checkbox to return only visible columns. When unchecked, all columns (including hidden columns) will be returned.
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint uses pagination to handle tables with large numbers of columns efficiently, automatically fetching additional pages as needed.

    Table IDs are unique identifiers within a document. You can find table IDs by using the "List Tables" endpoint first. Column information includes column names, IDs, types, and formatting details. For complete information about listing columns, see the Coda List Columns API Documentation.

    List Rows

    This endpoint retrieves rows from a specific table in a Coda document with optional filtering and sorting. Use this endpoint when you need to extract table data, sync Coda data to other systems, or analyze table contents.

    • Enter the Document ID in the Document ID field. This should match the exact ID of a document in your Coda account.
    • Enter the Table ID in the Table ID field. You can find this ID by using the "List Tables" endpoint to retrieve available tables and their corresponding IDs.
    • Optionally, enter a filter query in the Filter Query field to filter rows. The query uses Coda's query syntax (e.g., c-tuVwxYz:"Apple" to filter by a specific column value). Leave empty to retrieve all rows.
    • Optionally, select a sort order from the Sort By field. Available options are "Created At" (by creation time), "Updated At" (by last update time), or "Natural" (as they appear in the table). The default is "Created At".
    • Optionally, check the Use Column Names checkbox to use column names instead of IDs in the output. When unchecked, column IDs are used.
    • Optionally, select a value format from the Value Format field. Available options are "Simple" (basic JSON values), "Simple With Arrays" (arrays as JSON arrays), or "Rich" (rich formatting with metadata). The default is "Simple".
    • Optionally, check the Visible Only checkbox to return only visible rows. When unchecked, all rows (including hidden rows) will be returned.
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint uses pagination to handle tables with large numbers of rows efficiently, automatically fetching additional pages as needed.

    This endpoint is the primary way to extract data from Coda tables. The filter query syntax allows you to filter rows based on column values. For complete information about listing rows and query syntax, see the Coda List Rows API Documentation.

    List Formulas

    This endpoint retrieves a list of named formulas within a specific Coda document. Use this endpoint when you need to discover available formulas, analyze formula definitions, or build workflows that reference specific formulas.

    • Enter the Document ID in the Document ID field. This should match the exact ID of a document in your Coda account.
    • Optionally, select a sort order from the Sort By field. Available options are "Default" (natural order) or "Name" (alphabetical by name).
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint uses pagination to handle documents with large numbers of formulas efficiently, automatically fetching additional pages as needed.

    Named formulas in Coda are reusable formula definitions that can be referenced throughout a document. This endpoint returns formula metadata including names, IDs, and definitions. For complete information about listing formulas, see the Coda List Formulas API Documentation.

    List Controls

    This endpoint retrieves a list of controls (buttons, sliders, etc.) within a specific Coda document. Use this endpoint when you need to discover available controls, analyze control configurations, or build workflows that interact with document controls.

    • Enter the Document ID in the Document ID field. This should match the exact ID of a document in your Coda account.
    • Optionally, select a sort order from the Sort By field. Available options are "Default" (natural order) or "Name" (alphabetical by name).
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint uses pagination to handle documents with large numbers of controls efficiently, automatically fetching additional pages as needed.

    Controls in Coda are interactive elements like buttons and sliders that can trigger actions or update values. This endpoint returns control metadata including names, IDs, and configurations. For complete information about listing controls, see the Coda List Controls API Documentation.

    Get Document Analytics

    This endpoint retrieves analytics data for specific Coda documents. Use this endpoint when you need to analyze document usage, track engagement metrics, or monitor document performance over time.

    • Enter the Document ID in the Document ID field. This should match the exact ID of a document in your Coda account.
    • Optionally, enter a start date in the Since Date field in YYYY-MM-DD format (e.g., 2025-01-01). This defines the start of the analytics date range. The default is 2025-01-01.
    • Optionally, enter an end date in the Until Date field in YYYY-MM-DD format (e.g., 2025-12-31). This defines the end of the analytics date range. The default is 2025-12-31.
    • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
    • The endpoint uses pagination to handle analytics data efficiently, automatically fetching additional pages as needed.

    Document analytics provide insights into document usage, including view counts, edit activity, and user engagement metrics. The date range parameters allow you to analyze specific time periods. For complete information about document analytics, see the Coda List Doc Analytics API Documentation.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Coda data sources can be manually configured to ingest data from any valid Coda API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Coda sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Coda API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API (most common for Coda data sources)

API Endpoint URL

  1. Enter the URL of the Coda API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters.

Coda API URLs typically follow the format: https://coda.io/apis/v1/docs/{docId} for document operations, or https://coda.io/apis/v1/docs/{docId}/tables/{tableId}/rows for table operations. Replace {docId} and {tableId} with actual document and table identifiers. Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For complete information about Coda API endpoints, see the Coda API Documentation.

Request Headers

  1. If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

You do not need to include authentication headers (Authorization: Bearer {token}) as these are automatically included from your credentials. However, you may need to include additional headers for specific Coda API features. The Content-Type header should be set to application/json for most Coda API requests.

Response Data Path

  1. Enter the JSON path expression that identifies the location of the data array in the API response in the Response Data Path field. This path tells Nexla where to find the array of records in the JSON response.

For Coda API responses, the data path varies by endpoint. For list endpoints, use $.items[*] to extract individual items from the items array. For single item endpoints, use $ to extract the entire object. JSON path expressions use dot notation and array indexing to navigate the response structure. For complete information about Coda API response formats, see the Coda API Documentation.

Schedule

  1. Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format to define the frequency and timing of data ingestion.

Common cron expressions include: 0 6 * * * for daily at 6 AM, 0 */6 * * * for every 6 hours, and 0 0 * * 0 for weekly on Sunday at midnight. For more information about cron expressions, see the Nexla documentation on scheduling.