Secoda API

Secoda is an AI platform for data and analytics that helps teams manage trusted metadata, lineage, documentation, governance, and workspace activity. The Secoda API connector reads catalog resources, integrations, database assets, dashboards, lineage, questions, documents, monitors, audit logs, and AI usage data from a Secoda workspace, and can send approved create, update, and delete requests to Secoda API endpoints.

Power end-to-end data operations for your Secoda API API with Nexla. Our bi-directional Secoda API connector is purpose-built for Secoda API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Secoda API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Secoda API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Secoda API credential in Nexla, generate an API key in the Secoda workspace that has access to the data and write operations you plan to use. Secoda's API documentation states that API requests require an Authorization header with a bearer token, and that API keys are generated from workspace settings.

To obtain a Secoda API key:

1. Sign in to your Secoda workspace with a user account that has access to the API settings.

2. Navigate to Workspace settings.

3. Open the API page to view existing API keys.

4. Click Generate New API Key.

5. Copy the generated key immediately and store it securely. Secoda notes that the key has the same access to the workspace as the user who created it.

6. Confirm the workspace region so API requests use the correct base URL. Secoda documents api.secoda.co for US workspaces, eapi.secoda.co for EU workspaces, and aapi.secoda.co for APAC workspaces. Managed or on-premise workspaces use the custom workspace domain followed by the API version path.

Treat the Secoda API key as a sensitive secret. Rotate the key if it is exposed, and generate keys from an account with the minimum workspace access needed for the sources or destinations you plan to run.

For more information, see the Secoda API authentication guide and Secoda API getting started guide.

Authenticate

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

   Resource descriptions are recommended but are not required. Use them to identify the Secoda workspace, region, or access level represented by this credential.

3. Enter the Secoda API key in the API Key field.

4. Enter the Secoda API base URL for the workspace. The default value is https://api.secoda.co for US workspaces. Use https://eapi.secoda.co for EU workspaces, https://aapi.secoda.co for APAC workspaces, or the custom managed workspace domain for managed or on-premise deployments. Nexla sends the key to Secoda as a bearer token in the Authorization header when running sources and destinations.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Secoda API connector tile, then select the credential that will be used to connect to the Secoda workspace, and click Next; or, create a new Secoda API credential for use in this flow. The credential controls the Secoda API base URL, so use the credential that matches the workspace region or managed domain.

In Nexla, Secoda API data sources can be created using pre-built endpoint templates. These templates cover common Secoda API resources such as catalog assets, integrations, database metadata, dashboards, lineage, workspace users, documents, monitors, audit logs, and AI usage data.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources for common Secoda API endpoints. Secoda's APIs generally follow a CRUD pattern, and the read templates in this connector focus on list-style endpoints that are appropriate for ingestion. 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.

List Resources

Use this endpoint to list all catalog resources. The resources can be sorted or filtered by most of the fields in the response, using the Sort and Filter JSON objects respectively. More d...

• Configure optional filters for this endpoint as needed:

  • Page: Optional. The page number for paginated results.
  • Teams: Optional. The ID of the team the resources should filter by.
  • Filter: Optional. A serialized and URL encoded JSON object to define filters on the catalog resources. See Catalog Filter for the definition of this JS...
  • Sort: Optional. A serialized and URL encoded JSON object to define the sort pattern on the catalog resources. See Catalog Sort for the definition of th...
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Integrations

This endpoint will return all the integrations active in your workspace.

• Configure optional filters for this endpoint as needed:

  • Type: Optional. The type of integrations to filter.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Databases

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Integration ID
  • Title: Optional. Title of the database
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Schemas

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Integration ID
  • Parent Id: Optional. ID of the database
  • Title: Optional. Title of the schema
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Tables

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Integration ID
  • Parent Id: Optional. ID of the schema
  • Title: Optional. Title of the table
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Columns

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Optional. Filter columns by integration identifier.
  • Parent Id: Optional. Optional. Filter columns by parent identifier. This could be the ID of the table or of the parent column in the case of nested columns.
  • Title: Optional. Optional. Filter columns by title of the column.
  • Table Title: Optional. Optional. Filter columns by title of the table that the columns belong to. If several integrations have the same naming of tables, it is recommended to combine this with the `integration_...
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Dashboards

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Integration ID
  • Title: Optional. Title of the dashboard
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Charts

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Integration ID
  • Parent Id: Optional. ID of the dashboard
  • Title: Optional. Title of the chart
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Lineage

Get lineage objects with optional filtering by source and destination entity.

• Configure optional filters for this endpoint as needed:

  • From Entity: Optional. Optional from_entity filter.
  • From Entity Id: Optional. Optional from_entity_id filter.
  • From Entity In: Optional. Optional from_entity__in filter.
  • To Entity: Optional. Optional to_entity filter.
  • To Entity Id: Optional. Optional to_entity_id filter.
  • To Entity In: Optional. Optional to_entity__in filter.
  • Integration Type: Optional. Optional integration_type filter.
  • Integration Type: Optional. Optional integration__type filter.
  • Page: Optional. Optional page filter.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Tags

Get a list of tags. No filtering is currently available.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Users

Get a list of users.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Teams

Get a paginated list of teams in the workspace.

• Configure optional filters for this endpoint as needed:

  • Include Archived: Optional. Optional include_archived filter.
  • Only Joined: Optional. Optional only_joined filter.
  • Only Write: Optional. Optional only_write filter.
  • Page: Optional. Optional page filter.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Groups

Get a list of user groups in the workspace.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Collections

This endpoint allows you to retrieve a list of collections. You can optionally filter the collections by title using the "title" query parameter.

• Configure optional filters for this endpoint as needed:

  • Title: Optional. Filter collections by title (optional)
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Questions

This endpoint allows you to retrieve a list of questions.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Question Replies

This endpoint allows you to retrieve a list of replies. You can optionally filter the replies by question_id using the "question_id" query parameter.

• Configure optional filters for this endpoint as needed:

  • Question Id: Optional. Filter replies by question_id (optional)
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Documents

This endpoint allows you to retrieve a list of documents. You can optionally filter the documents by title using the "title" query parameter.

• Configure optional filters for this endpoint as needed:

  • Title: Optional. Filter documents by title (optional)
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Queries

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Monitors

This endpoint allows you to retrieve a list of all the monitors in your workspace.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Incidents

This endpoint allows you to retrieve a list of all the incidents in your workspace.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Measurements

This endpoint allows you to retrieve a list of all the measurements in your workspace filtered by a Monitor or Incident. A query param of either the Monitor ID or Incident ID is required....

• Configure optional filters for this endpoint as needed:

  • Monitor: Optional. The unique identifier of the monitor
  • Incident Id: Optional. The unique identifier of the incident
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Event Categories

List all the event categories in the workspace. Optional filter by title.

• Configure optional filters for this endpoint as needed:

  • Title: Optional. Filter event categories by title
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Events

Warning: This endpoint is deprecated. Prefer the List Resources endpoint with an equivalent type filter for canonical catalog coverage.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Filter by integration ID
  • Parent Id: Optional. Filter by parent ID
  • Title: Optional. Filter by title
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Event Properties

Retrieve a list of events with optional filtering using the integration_id, parent_id (the event), and title.

• Configure optional filters for this endpoint as needed:

  • Integration Id: Optional. Filter by integration ID
  • Parent Id: Optional. Filter by parent ID
  • Title: Optional. Filter by title
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Custom Properties

Get all custom properties in the workspace.

• No endpoint-specific fields are required. Nexla fetches this feed with the selected Secoda credential.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Audit Logs

This endpoint retrieves a list of audit logs for the workspace, providing a comprehensive record of actions taken by users, systems, and integrations. The audit logs can be filtered and...

• Configure optional filters for this endpoint as needed:

  • Filter: Optional. A serialized and URL encoded JSON object to define filters on the audit logs. This follows the same pattern as catalog filters, allowing for complex filtering based on multiple criteria.
  • Sort: Optional. A serialized and URL encoded JSON object to define the sort pattern on the audit logs.
  • Page: Optional. Page number for paginated results (default is 1)
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List AI Chats

Retrieve a paginated list of AI chat conversations in the workspace with detailed analytics data. Each result includes the user's prompts, feedback sentiments, queried resources, time sa...

• Configure optional filters for this endpoint as needed:

  • Limit: Optional. Maximum number of results per page
  • Offset: Optional. Number of results to skip for pagination
  • Page: Optional. Page number for paginated results
  • Sort Order: Optional. Sort order for results
  • Sort By: Optional. Field to sort results by
  • Time Range: Optional. Time range to filter chats by
  • User Ids: Optional. Filter by specific user IDs
  • Created At: Optional. Filter by creation date upper bound
  • Filter: Optional. A serialized JSON object to define filters. Supports filtering by users, teams, system_rating, feedback sentiment, date, AI persona, and time savings category.
  • Filters: Optional. Alias for the filter parameter
  • Search Term: Optional. Search term to filter by chat title or prompt content
  • Sentiment Filter: Optional. Filter by user feedback sentiment
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Rated AI Chats

Retrieve a paginated list of AI chat conversations that have received user feedback ratings (thumbs up or thumbs down). Useful for analyzing prompt quality and identifying areas for impro...

• Configure optional filters for this endpoint as needed:

  • Limit: Optional. Maximum number of results per page
  • Offset: Optional. Number of results to skip for pagination
  • Sort Order: Optional. Sort order for results
  • Time Range: Optional. Time range to filter chats by
  • Sentiment Filter: Optional. Filter by feedback sentiment
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List AI Prompts by Member

Retrieve a paginated list of workspace members with their AI prompt counts. Useful for measuring per-user adoption and identifying power users.

• Configure optional filters for this endpoint as needed:

  • Limit: Optional. Maximum number of members to return
  • Offset: Optional. Number of members to skip for pagination
  • Sort Order: Optional. Sort members by prompt count
  • Time Range: Optional. Time range to count prompts within
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

List Teams V2

Get a list of teams in the workspace.

• Configure optional filters for this endpoint as needed:

  • Include Archived: Optional. Optional include_archived filter.
  • Only Joined: Optional. Optional only_joined filter.
  • Only Write: Optional. Optional only_write filter.
• Use the default sync schedule or adjust the schedule in the source settings before activating the flow.

Many Secoda list endpoints return paginated responses with page metadata and next-page links. Nexla follows the configured pagination template when the endpoint exposes pagination in the Secoda OpenAPI schema.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Secoda API data sources can also be manually configured to ingest data from any valid Secoda API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Secoda documents api.secoda.co, eapi.secoda.co, and aapi.secoda.co as regional API hosts, plus custom domains for managed and on-premise workspaces. For manual requests, include the same Secoda API credential used by the connector. The API key must be sent as a bearer token in the Authorization header. For endpoint behavior and examples, see the Secoda API reference and Secoda API examples.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Secoda API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Secoda API destination, and select the Send to Destination option from the menu. Select the Secoda API connector from the list of available destination connectors, then select the credential that will be used to connect to the Secoda workspace, and click Next; or, create a new Secoda API credential for use in this flow.

Endpoint templates

Nexla provides pre-built destination templates for common Secoda write operations. Each template sets the API method and endpoint path for a specific Secoda operation. The connector includes templates for supported POST, PUT, PATCH, and DELETE operations from the Secoda API. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Resource

Creates a new Secoda resource using the JSON object in each Nexset record.

• The request body is sent as JSON. Use field names and values that match the Secoda API request schema for the resource type you are creating.
• No endpoint path parameter is required for this template.

Update Resource

Updates an existing Secoda resource by ID using a partial JSON request body.

• Enter the required Resource ID path parameter. You can provide a literal ID or map it from a Nexset field.
• Only include fields that should be changed in the request body.

Delete Resource

Deletes an existing Secoda resource by ID.

• Enter the required Resource ID path parameter. You can provide a literal ID or map it from a Nexset field.

:::warning Important Delete operations remove data from Secoda. Verify that the selected IDs and flow filters target only the intended records before activating the destination. :::

Manual configuration

Secoda API destinations can also be manually configured to send data to any valid Secoda API endpoint that is not included in the pre-built templates. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Secoda destination templates use POST, PUT, PATCH, or DELETE. Use the base URL from the selected credential and include any required path parameters in the endpoint path. For create and update operations, the default body template is {message.json}, which sends each Nexset record as a JSON object. Confirm that your Nexset schema matches the request schema expected by the selected Secoda API endpoint. For complete endpoint details, see the Secoda API reference.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Secoda API endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Secoda API endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.