Skip to main content

Kargo Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Kargo location.
kargo.png

Kargo

Follow the instructions below to create a new data flow that ingests data from a Kargo 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 Kargo connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Kargo account, and click Next; or, create a new Kargo credential for use in this flow.

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

    Kargo sources can also be configured manually, allowing you to ingest data from Kargo 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 Kargo endpoints. Each template is designed specifically for the corresponding Kargo 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.

    Fetch List of Reports

    List submitted report requests

    • This endpoint automatically retrieves a list of all submitted report requests from your Kargo account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to https://datasharingapi.prod.kargo.com/v1/reports to retrieve a list of reports. The endpoint URL is automatically constructed based on the Kargo Data Sharing API base URL.
    • The endpoint uses pagination (iteration.type: paging.next.url) to retrieve all reports. Pagination uses the next URL from the API response to navigate through pages. The next page URL is extracted from $.links.next in the API response. The endpoint will automatically fetch all pages until all reports are retrieved.
    • The response data path is $.data.rows[*], which extracts all report rows from the data.rows array in the API response.

    This endpoint retrieves a list of all submitted report requests from your Kargo account. The endpoint requires authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained through the authentication endpoint using your username and password. The endpoint supports pagination through the next URL mechanism, which allows you to retrieve large lists of reports efficiently. For detailed information about the API response format, pagination, and available fields, see the Kargo Data Sharing API documentation.

    Get Completed Reports

    View completed reports data

    • Enter the Report ID in the Report ID field. This is the unique identifier for a completed report that you want to retrieve. You can obtain Report IDs from the "Fetch List of Reports" endpoint or from your Kargo account dashboard.
    • The endpoint uses GET requests to https://datasharingapi.prod.kargo.com/v1/completed-reports/{report_id} where {report_id} is the Report ID you configured. The endpoint URL is automatically constructed based on the Kargo Data Sharing API base URL and the Report ID you specify.
    • The endpoint uses pagination (iteration.type: paging.next.url) to retrieve all report data. Pagination uses the next URL from the API response to navigate through pages. The next page URL is extracted from $.links.next in the API response. The endpoint will automatically fetch all pages until all report data is retrieved.
    • The response data path is $.data.rows[*], which extracts all data rows from the completed report.

    This endpoint retrieves data from a completed report in your Kargo account. The endpoint requires authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The Report ID identifies which completed report to retrieve. The endpoint supports pagination through the next URL mechanism, which allows you to retrieve large reports efficiently. For detailed information about completed reports, pagination, and the API response format, see the Kargo Data Sharing API documentation.

Configure Manually​

Kargo data sources can be manually configured to ingest data from any valid Kargo Data Sharing 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 Kargo sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Kargo Data Sharing API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Kargo Data Sharing API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Kargo Data Sharing 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. Kargo Data Sharing API endpoints typically follow the pattern https://datasharingapi.prod.kargo.com/v1/{endpoint_path}.

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. The endpoint requires authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained through the authentication endpoint using your username and password. For detailed information about Kargo Data Sharing API endpoints, authentication, and available APIs, see the Kargo Data Sharing API documentation.