Skip to main content

Tune Network Data Source

Follow the instructions below to create a new data flow that ingests data from a Tune Network source in Nexla.
tune_network_api.png

Tune Network

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

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

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

    Get Entities from Tune

    This endpoint template retrieves all ad campaign objects from your Tune Network account. Use this template when you need to access ad campaign information, campaign status, or campaign metadata for analysis, reporting, or integration purposes.

    • Optionally enter the Status of Ad campaign in the Status of Ad campaign field. This should be the status filter for the ad campaigns you want to retrieve (e.g., active, paused, deleted). The Status determines which ad campaigns will be retrieved. You can select from the available options: Active, Paused, or Deleted. If left empty, all ad campaigns will be retrieved. The endpoint uses incrementing page number pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns all ad campaign objects from your Tune Network account, including campaign IDs, names, status, and other campaign metadata. The endpoint uses incrementing page number pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of data.

    For detailed information about ad campaigns, API response structures, pagination, and available campaign data, see the Tune Network API documentation.

    Get Ad Campaign Creatives by filters

    This endpoint template retrieves ad campaign creatives filtered by status and ad campaign ID from your Tune Network account. Use this template when you need to access creative information, creative assets, or creative metadata for specific ad campaigns for analysis, reporting, or integration purposes.

    • Optionally enter the Status in the Status field. This should be the status filter for the creatives you want to retrieve (e.g., active, paused, deleted). The Status determines which creatives will be retrieved. You can select from the available options: Active, Paused, or Deleted. If left empty, all creatives matching the other filters will be retrieved.
    • Optionally enter the Ad Campaign ID in the Ad Campaign ID field. This should be the unique identifier of the ad campaign whose creatives you want to retrieve. The Ad Campaign ID determines which ad campaign's creatives will be retrieved. You can find the Ad Campaign ID by using the "Get Entities from Tune" endpoint. The default value is 1. The endpoint uses incrementing page number pagination to handle large datasets efficiently.

    This endpoint returns ad campaign creatives filtered by status and ad campaign ID from your Tune Network account, including creative IDs, names, status, and other creative metadata. The endpoint uses incrementing page number pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of data.

    The Ad Campaign ID can be found by using the "Get Entities from Tune" endpoint. For detailed information about creatives, API response structures, pagination, and available creative data, see the Tune Network API documentation.

    Get Advertisers

    This endpoint template retrieves all advertisers from your Tune Network account. Use this template when you need to access advertiser information, advertiser status, or advertiser metadata for analysis, reporting, or integration purposes.

    • Optionally enter the Status in the Status field. This should be the status filter for the advertisers you want to retrieve (e.g., pending, active, blocked, deleted, rejected). The Status determines which advertisers will be retrieved. You can select from the available options: Pending, Active, Blocked, Deleted, or Rejected. If left empty, all advertisers will be retrieved. The endpoint uses incrementing page number pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns all advertisers from your Tune Network account, including advertiser IDs, names, status, and other advertiser metadata. The endpoint uses incrementing page number pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of data.

    For detailed information about advertisers, API response structures, pagination, and available advertiser data, see the Tune Network API documentation.

    Get advertiser invoices

    This endpoint template retrieves advertiser invoices filtered by payment status, sent status, and invoice status from your Tune Network account. Use this template when you need to access invoice information, billing data, or invoice metadata for analysis, reporting, or integration purposes.

    • Optionally enter the Is Paid in the Is Paid field. This should be the payment status filter for the invoices you want to retrieve (True for paid invoices, False for unpaid invoices). The Is Paid determines which invoices will be retrieved. You can select from the available options: Yes (True) or No (False). If left empty, all invoices matching the other filters will be retrieved.
    • Optionally enter the Is Sent in the Is Sent field. This should be the sent status filter for the invoices you want to retrieve (True for sent invoices, False for unsent invoices). The Is Sent determines which invoices will be retrieved. You can select from the available options: Yes (True) or No (False). If left empty, all invoices matching the other filters will be retrieved.
    • Optionally enter the Status in the Status field. This should be the invoice status filter for the invoices you want to retrieve (e.g., active, incomplete, deleted). The Status determines which invoices will be retrieved. You can select from the available options: Active, Incomplete, or Deleted. If left empty, all invoices matching the other filters will be retrieved. The endpoint uses incrementing page number pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns advertiser invoices filtered by payment status, sent status, and invoice status from your Tune Network account, including invoice IDs, amounts, payment status, and other invoice metadata. The endpoint uses incrementing page number pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of data.

    For detailed information about advertiser invoices, API response structures, pagination, and available invoice data, see the Tune Network API documentation.

    Get Advertiser User

    This endpoint template retrieves advertiser users filtered by status from your Tune Network account. Use this template when you need to access advertiser user information, user status, or user metadata for analysis, reporting, or integration purposes.

    • Optionally enter the Status in the Status field. This should be the status filter for the advertiser users you want to retrieve (e.g., active, blocked, deleted). The Status determines which advertiser users will be retrieved. You can select from the available options: Active, Blocked, or Deleted. If left empty, all advertiser users will be retrieved. The endpoint uses incrementing page number pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns advertiser users filtered by status from your Tune Network account, including user IDs, names, status, and other user metadata. The endpoint uses incrementing page number pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of data.

    For detailed information about advertiser users, API response structures, pagination, and available user data, see the Tune Network API documentation.

    Get Affiliate

    This endpoint template retrieves affiliates filtered by status from your Tune Network account. Use this template when you need to access affiliate information, affiliate status, or affiliate metadata for analysis, reporting, or integration purposes.

    • Optionally enter the Status in the Status field. This should be the status filter for the affiliates you want to retrieve (e.g., pending, active, blocked, deleted, rejected). The Status determines which affiliates will be retrieved. You can select from the available options: Pending, Active, Blocked, Deleted, or Rejected. If left empty, all affiliates will be retrieved. The endpoint uses incrementing page number pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns affiliates filtered by status from your Tune Network account, including affiliate IDs, names, status, and other affiliate metadata. The endpoint uses incrementing page number pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of data.

    For detailed information about affiliates, API response structures, pagination, and available affiliate data, see the Tune Network API documentation.

    Get Offers

    This endpoint template retrieves offers filtered by status from your Tune Network account. Use this template when you need to access offer information, offer status, or offer metadata for analysis, reporting, or integration purposes.

    • Optionally enter the Status in the Status field. This should be the status filter for the offers you want to retrieve (e.g., pending, active, paused, deleted, expired). The Status determines which offers will be retrieved. You can select from the available options: Pending, Active, Paused, Deleted, or Expired. If left empty, all offers will be retrieved. The endpoint uses incrementing page number pagination to handle large datasets efficiently, returning up to 100 records per page by default.

    This endpoint returns offers filtered by status from your Tune Network account, including offer IDs, names, status, and other offer metadata. The endpoint uses incrementing page number pagination with page and limit parameters to handle large datasets efficiently. Nexla will automatically follow the pagination to fetch subsequent pages of data.

    For detailed information about offers, API response structures, pagination, and available offer data, see the Tune Network 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​

Tune Network data sources can be manually configured to ingest data from any valid Tune Network 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 Tune Network 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 Tune Network API from the Method pulldown menu. The most common methods are:

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

API Endpoint URL​

  1. Enter the URL of the Tune Network 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. The URL format should be https://{network_id}.api.hasoffers.com/Apiv3/json?Target={target}&Method={method} where {network_id} is your Network ID.

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.

Path to Data​

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, when a request call is used to fetch a list of entities, the API will typically return an array of entity records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when Tune Network API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $[*] to access an array of entities within a response).

    • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/entities/entity to access entity elements within an entities element).

    Path to Data Example:

    If the Tune Network API response is in JSON format and includes a top-level array that contains the relevant data, the path to the response would be entered as $[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Endpoint Testing (Manual Configuration)​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. 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.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Tune Network 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.