Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a ReSci source in Nexla.
resci.png

ReSci

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

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

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

    List Impost Jobs

    This endpoint template returns a list of import jobs in descending chronological order, 10 records at a time, from your ReSci account. Use this template when you need to retrieve information about import jobs, including job IDs, status, and other job metadata.

    • This endpoint automatically retrieves import jobs from your ReSci account. The endpoint uses offset-based pagination to handle large datasets efficiently, returning 10 records at a time.

    This endpoint returns a list of import jobs in descending chronological order from your ReSci account, including job IDs, status, and other job metadata. The endpoint uses offset-based pagination with offset and count parameters to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the offset parameter.

    For detailed information about import jobs, API response structures, pagination, and available job data, see the ReSci API documentation.

    Get Lists

    This endpoint template retrieves all lists that have not been deleted from your ReSci account. Use this template when you need to retrieve information about available lists, including list IDs, names, and other list metadata.

    • This endpoint automatically retrieves all non-deleted lists from your ReSci account. No additional configuration is required beyond selecting this endpoint template.

    This endpoint returns all lists that have not been deleted from your ReSci account, including list IDs, names, and other list metadata. Use this endpoint to discover which lists are available in your ReSci account.

    For detailed information about list management, API response structures, and available list data, see the ReSci 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​

ReSci data sources can be manually configured to ingest data from any valid ReSci 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 ReSci sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

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 ReSci API from the Method pulldown menu. ReSci API typically uses GET method for retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the ReSci API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your ReSci endpoint (e.g., https://data.retentionscience.com/v3/import_jobs, https://data.retentionscience.com/v3/lists). Include any required query parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The ReSci API endpoint URL should include the API version (/v3/) and the resource type path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For ReSci API responses, use $[*] to extract all items from the response array, or $.data[*] to extract all items from the data array, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your ReSci API response. ReSci API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. ReSci API uses offset-based pagination with offset and count parameters for some endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For offset-based pagination, specify the offset parameter name (offset), page size parameter name (count), and starting offset value.

Save the Data Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the data source configuration for later use.