CircleCI

CircleCI is a continuous integration and continuous deployment platform that automates software development workflows, enabling teams to build, test, and deploy applications efficiently with powerful CI/CD pipelines and cloud-based infrastructure.

Power end-to-end data operations for your CircleCI API with Nexla. Our bi-directional CircleCI connector is purpose-built for CircleCI, 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 CircleCI or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your CircleCI 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 CircleCI credential, you need to obtain an API key from your CircleCI account. The API key is required to authenticate with the CircleCI API v2.

To obtain your API key, you need to have a CircleCI account with API access enabled. Once you have access to your account, you can generate an API key from your account settings. The API key is sent in the Circle-Token header to authenticate all API requests to the CircleCI API v2. For detailed information about API key setup and authentication, refer to the CircleCI API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key	Yes	Yes	Your CircleCI API key

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.

New Credential Overlay – CircleCI

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

3. Enter your CircleCI API key in the API Key field. This is the API key you obtained from your CircleCI account settings. The API key is sent in the Circle-Token header to authenticate all API requests to the CircleCI API v2.

   Keep your API key secure and do not share it publicly. The API key provides access to your CircleCI account and should be treated as sensitive information. The API key is included in the Circle-Token header for all API requests to the CircleCI API v2. For detailed information about obtaining and managing API keys, see the CircleCI API documentation.

4. 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 CircleCI connector tile, then select the credential that will be used to connect to the CircleCI instance, and click Next; or, create a new CircleCI credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common CircleCI endpoints. 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.

Fetch all Project Pipelines

This endpoint fetches all pipelines for a project. Use this endpoint when you need to access pipeline information, build status, or pipeline execution details for a specific CircleCI project.

• Enter the project slug in the Project Slug field. The project slug should be in the form vcs-slug/org-name/repo-name (e.g., github/nexla/developers.nexla.com). The / characters may be URL-escaped. The default value is / if not specified.

• The endpoint uses GET requests to https://circleci.com/api/v2/project/{'{project_slug}'}/pipeline where {project_slug} is the project slug you provide. The endpoint URL is automatically constructed based on the CircleCI API base URL and the project slug.
• The endpoint uses token-based pagination, automatically fetching additional pages as needed using the page-token query parameter. When a response includes a next_page_token value, Nexla automatically uses it as the page-token parameter in the subsequent request to fetch the next page of results.
• The endpoint will return all pipelines for the specified project. The response data is extracted from the items array in the API response ($.items[*]), with each pipeline record processed individually.

Project slugs should be in the form vcs-slug/org-name/repo-name where vcs-slug is your version control system (e.g., github, bitbucket), org-name is your organization name, and repo-name is your repository name. This endpoint supports pagination through the page-token mechanism. When a response includes a next_page_token value, Nexla automatically uses it as the page-token parameter in the subsequent request to fetch the next page of results. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the page-token mechanism. The response data path is $.items[*], which extracts all items from the items array in the API response. For detailed information about fetching project pipelines, see the CircleCI API documentation.

Fetch metrics and trends for a project

This endpoint gets summary metrics and trends for a project at workflow and branch level. Use this endpoint when you need to access project performance metrics, workflow analytics, or branch-level insights.

• Enter the project slug in the Project Slug field. The project slug should be in the form vcs-slug/org-name/repo-name (e.g., github/nexla/developers.nexla.com). The / characters may be URL-escaped. The default value is / if not specified.

• The endpoint uses GET requests to https://circleci.com/api/v2/insights/pages/{'{project_slug}'}/summary where {project_slug} is the project slug you provide. The endpoint URL is automatically constructed based on the CircleCI API base URL and the project slug.
• The endpoint does not use pagination and returns the complete project summary metrics in a single request.
• The endpoint will return summary metrics and trends for the specified project. The response data is extracted from the root-level object in the API response ($), and Nexla will process the entire response structure.

Project slugs should be in the form vcs-slug/org-name/repo-name where vcs-slug is your version control system (e.g., github, bitbucket), org-name is your organization name, and repo-name is your repository name. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $, which extracts the entire root-level object from the API response. For detailed information about fetching project summaries, see the CircleCI API documentation.

Fetch Workflow Timeseries Data

This endpoint fetches timeseries data for all workflows that have run on the default branch. Use this endpoint when you need to access workflow performance trends, execution patterns, or time-based analytics for a CircleCI project.

• Enter the project slug in the Project Slug field. The project slug should be in the form vcs-slug/org-name/repo-name (e.g., github/nexla/developers.nexla.com). The / characters may be URL-escaped. The default value is / if not specified.

• The endpoint uses GET requests to https://circleci.com/api/v2/insights/time-series/{'{project_slug}'}/workflows where {project_slug} is the project slug you provide. The endpoint URL is automatically constructed based on the CircleCI API base URL and the project slug.
• The endpoint uses token-based pagination, automatically fetching additional pages as needed using the page-token query parameter. When a response includes a next_page_token value, Nexla automatically uses it as the page-token parameter in the subsequent request to fetch the next page of results.
• The endpoint will return timeseries data for all workflows on the default branch. The response data is extracted from the items array in the API response ($.items[*]), with each workflow timeseries record processed individually.

Project slugs should be in the form vcs-slug/org-name/repo-name where vcs-slug is your version control system (e.g., github, bitbucket), org-name is your organization name, and repo-name is your repository name. This endpoint supports pagination through the page-token mechanism. When a response includes a next_page_token value, Nexla automatically uses it as the page-token parameter in the subsequent request to fetch the next page of results. The endpoint uses token-based pagination (iteration.type: paging.next.token) through the page-token mechanism. The response data path is $.items[*], which extracts all items from the items array in the API response. For detailed information about fetching workflow timeseries data, see the CircleCI API documentation.

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

CircleCI data sources can also be manually configured to ingest data from any valid CircleCI API v2 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.

CircleCI API endpoints typically follow the pattern https://circleci.com/api/v2/{endpoint_path}. API key authentication is sent in the Circle-Token header, which is handled automatically by your credential configuration. CircleCI API responses typically use an items array to contain the data for list endpoints (path to data: $.items[*]), or a root-level object for summary endpoints (path to data: $).

Once all of the relevant settings have been configured, click the Save button to save your data source configuration. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.