Skip to main content

UpPromote Data Source

Follow the instructions below to create a new data flow that ingests data from an UpPromote source in Nexla.
uppromote_api.png

UpPromote

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

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

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

    This endpoint template retrieves all affiliates in the account from your UpPromote account. Use this template when you need to access affiliate information, affiliate status, or affiliate metadata for analysis, reporting, or integration purposes.

    • This endpoint automatically retrieves all affiliates in the account from your UpPromote account. No additional configuration is required beyond selecting this endpoint template. 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 affiliates in the account from your UpPromote 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 UpPromote API documentation.

    Get Affiliate

    This endpoint template retrieves a specific affiliate by ID from your UpPromote account. Use this template when you need to access detailed affiliate information, affiliate status, or affiliate metadata for a specific affiliate for analysis, reporting, or integration purposes.

    • Optionally enter the Affiliate_Id in the Affiliate_Id field. This should be the unique identifier of the affiliate you want to retrieve. The Affiliate_Id determines which affiliate's information will be retrieved. If left empty, the endpoint may return default or all available affiliates.

    This endpoint returns a specific affiliate by ID from your UpPromote account, including affiliate IDs, names, status, and other affiliate metadata. The Affiliate_Id identifies the specific affiliate whose information will be retrieved.

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

    Search Affiliate

    This endpoint template uses optional query parameters to search for an affiliate from your UpPromote account. The keyword searches for the Affiliate name or affiliate email. Use this template when you need to find affiliates by name or email for analysis, reporting, or integration purposes.

    • Optionally enter the Optional Search Query in the Optional Search Query field. This should be the search query for searching an affiliate. The keyword searches for the Affiliate name or affiliate email. The Search Query determines which affiliates will be returned in the search results. If left empty, the endpoint may return default or all available affiliates.

    This endpoint uses optional query parameters to search for an affiliate from your UpPromote account, allowing you to find affiliates by name or email. The keyword searches for the Affiliate name or affiliate email. The search results can be used to find specific affiliates or filter affiliate lists.

    For detailed information about affiliate search, API response structures, and available search options, see the UpPromote 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​

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

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

API Endpoint URL​

  1. Enter the URL of the UpPromote 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.

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 affiliates, the API will typically return an array of affiliate 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 UpPromote 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., $.data[*] to access an array of affiliates within a response object).

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

    Path to Data Example:

    If the UpPromote API response is in JSON format and includes a nested array named data that contains the relevant data, the path to the response would be entered as $.data[*].

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 UpPromote 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.