Kargo

Kargo is a mobile-first advertising platform that specializes in premium mobile ad experiences, providing brands and agencies with innovative ad formats, programmatic buying capabilities, and comprehensive analytics to maximize mobile advertising effectiveness and drive meaningful engagement.

Power end-to-end data operations for your Kargo API with Nexla. Our bi-directional Kargo connector is purpose-built for Kargo, 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 Kargo or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Kargo 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 Kargo credential, you need to obtain your Kargo username and password from your Kargo account. These credentials are required to authenticate with the Kargo Data Sharing API.

To obtain your Kargo credentials, you need to have a Kargo account. Once you have access to your account, you can use your existing Kargo username and password to authenticate with the API. The username and password are used to obtain an access token through the Kargo authentication endpoint. The access token is then sent in the Authorization header with the Bearer prefix for all API requests to the Kargo Data Sharing API. The Kargo Data Sharing API provides access to advertising performance reports, campaign data, and analytics information. For detailed information about authentication and available API endpoints, refer to the Kargo Data Sharing API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Username	Yes	No	Your Kargo username
Password	Yes	Yes	Your Kargo password

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 – Kargo

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

Kargo uses username and password authentication to obtain an access token. The username and password are sent to the Kargo authentication endpoint to obtain an access token, which is then used to authenticate API requests.

3. Enter your Kargo username in the Username field. This is the username you use to sign in to your Kargo account. The username is used along with the password to obtain an access token for API authentication.

4. Enter your Kargo password in the Password field. This is the password you use to sign in to your Kargo account. The password is used along with the username to obtain an access token for API authentication. The password is sensitive information and must be kept confidential.

   Keep your password secure and do not share it publicly. The password provides access to your Kargo account data and should be treated as sensitive information. Your Kargo username and password are the same credentials you use to sign in to your Kargo account. The credentials are sent to the Kargo authentication endpoint (https://datasharingapi.prod.kargo.com/v1/authenticate) to obtain an access token. Nexla automatically obtains and refreshes the access token as needed. The access token is sent in the Authorization: Bearer {token} header for all API requests to the Kargo Data Sharing API. For detailed information about authentication, token management, and available endpoints, see the Kargo Data Sharing API documentation.

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 Kargo connector tile, 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.

Endpoint templates

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

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.

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

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.

Select the format in which the data from the Kargo Data Sharing API will be received from the Content Format pulldown menu; the Kargo Data Sharing API typically returns data in JSON format. Then enter the URL of the Kargo Data Sharing API endpoint from which this source will fetch data in the Set API URL field. Kargo Data Sharing API endpoints typically follow the pattern https://datasharingapi.prod.kargo.com/v1/{endpoint_path}. Follow the instructions in Connect to Any API to configure the remaining settings, including date/time and lookup macros, path to data, metadata, and request headers.

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.

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 Kargo 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 Kargo destination, and select the Send to Destination option from the menu. Select the Kargo connector from the list of available destination 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Kargo endpoints. 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.

Submit Report

Submit a report. Check out the documentation URL for more details on record schema.

• This endpoint automatically submits reports to the Kargo Data Sharing API using data from your Nexset. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses POST requests to https://datasharingapi.prod.kargo.com/v1/reports to submit reports. The endpoint URL is automatically constructed based on the Kargo Data Sharing API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the report data to submit.
• Batch mode is disabled by default for this endpoint, which means each record from your Nexset will be sent as a separate API request. This ensures that each report is submitted individually.
• This endpoint does not automatically create a data source to track the responses received from the Kargo Data Sharing API after each call.

The request body must be properly formatted JSON that matches the Kargo Data Sharing API specification for submitting reports. The endpoint requires authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. The request body must conform to the record schema defined in the Kargo Data Sharing API documentation. For detailed information about submitting reports, including required fields, record schema, and request formats, see the Kargo Data Sharing API documentation.

Manual configuration

Kargo destinations can be manually configured to send data to 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 destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Select the format in which the Nexset data will be sent to the Kargo Data Sharing API from the Content Format pulldown menu; the Kargo Data Sharing API typically uses JSON format for request bodies. Then enter the URL of the Kargo Data Sharing API endpoint to which you want to send the Nexset data in the URL field. Kargo Data Sharing API endpoints typically follow the pattern https://datasharingapi.prod.kargo.com/v1/{endpoint_path}. Follow the instructions in Connect to Any API to configure the remaining settings, including request headers, attribute exclusions, record batching, and response webhooks.

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.

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 Kargo endpoint, open the destination resource menu, and select Activate.

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