Skip to main content

Data Source

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

Cue

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

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

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

    This endpoint gets campaigns from your Cue account. Use this endpoint when you need to access campaign information, campaign data, or campaign lists from your Cue account.

    • This endpoint automatically retrieves campaigns from your Cue account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to {api_url}/v1/campaigns?skip={skip}&take={take} where {api_url} is your Cue API URL from the credential configuration, {skip} is the pagination offset, and {take} is the page size. The endpoint URL is automatically constructed based on the Cue API base URL and pagination parameters.
    • The endpoint uses offset-based pagination, automatically fetching additional pages as needed. Pagination starts from offset 0 (skip=0) and increments by the page size (take=25) for each subsequent page. Nexla will continue fetching pages until all campaigns are retrieved.
    • The endpoint will return all campaigns. The response data is extracted from the root-level array in the API response ($[*]), with each campaign record processed individually.

    This endpoint supports pagination through the skip/take mechanism. Pagination starts from offset 0 (skip=0) with a page size of 25 records per page (take=25). The endpoint uses offset-based pagination (iteration.type: paging.incrementing.offset) through the skip/take query parameters. The response data path is $[*], which extracts all items from the root-level array in the API response. For detailed information about getting campaigns, see the Cue API documentation.

    Get Teams

    This endpoint gets teams from your Cue account. Use this endpoint when you need to access team information, team data, or team lists from your Cue account.

    • This endpoint automatically retrieves teams from your Cue account. No additional configuration is required beyond selecting this endpoint template.
    • The endpoint uses GET requests to {api_url}/v1/teams?skip={skip}&take={take} where {api_url} is your Cue API URL from the credential configuration, {skip} is the pagination offset, and {take} is the page size. The endpoint URL is automatically constructed based on the Cue API base URL and pagination parameters.
    • The endpoint uses offset-based pagination, automatically fetching additional pages as needed. Pagination starts from offset 0 (skip=0) and increments by the page size (take=25) for each subsequent page. Nexla will continue fetching pages until all teams are retrieved.
    • The endpoint will return all teams. The response data is extracted from the root-level array in the API response ($[*]), with each team record processed individually.

    This endpoint supports pagination through the skip/take mechanism. Pagination starts from offset 0 (skip=0) with a page size of 25 records per page (take=25). The endpoint uses offset-based pagination (iteration.type: paging.incrementing.offset) through the skip/take query parameters. The response data path is $[*], which extracts all items from the root-level array in the API response. For detailed information about getting teams, see the Cue 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​

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

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Cue 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. Cue API endpoints typically follow the pattern {api_url}/v1/{endpoint_path} where {api_url} is your Cue API URL from the credential configuration.

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 JWT/Token authentication with custom headers (X-Api-Consumer and X-Cue-UserId) and an Authorization header, which are handled automatically by your credential configuration. For detailed information about Cue API endpoints and available APIs, see the Cue API documentation.

Path to Data​

  1. Enter the JSON path that identifies the location of the relevant data within the API response in the Path to Data field. JSON paths use dot notation to navigate through nested JSON structures.

    • For example, if your API response has the structure [{"id": 1, "name": "..."}, ...], you would enter $[*] to extract all items from the root-level array.
    • Use $[*] to extract all items from a root-level array.
    • Use $ to extract the entire root-level object.

JSON paths are case-sensitive and must match the exact structure of your API response. Cue API responses may use different structures like root-level arrays or objects depending on the endpoint. Use the Test button to verify that your JSON path correctly extracts the desired data from the API response.

Save the Data Source​

  1. Once all configuration steps have been completed, click the Save button to save your data source configuration.

  2. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.