Skip to main content

Klue Data Source

The Klue connector enables you to extract competitive intelligence data including Cards, Battlecards, and Usage Data from your Klue workspace. This connector is particularly useful for applications that need to extract competitive intelligence, analyze competitor information, track battlecard usage, or integrate Klue data with other business systems. Follow the instructions below to create a new data flow that ingests data from a Klue source in Nexla.
klue_api.png

Klue

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

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

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

    Extract Cards

    This endpoint returns published Cards (drafts if audiences=curators) from your Klue workspace. Supports filtering by audiences, battlecards, competitors, topics, tags, IDs, and date ranges. Use this endpoint when you need to extract competitive intelligence cards for analysis, reporting, or integration with other systems.

    • Optionally, enter the page number for pagination in the Page Number field. The default value is 1. This endpoint uses pagination to handle large datasets efficiently.
    • Optionally, enter the number of Cards to return per page in the Results Per Page field. The default value is 100. You can adjust this value based on your needs and API rate limits.
    • Optionally, enter filters as a query string in the Optional Filters field. Filters can include audiences, battlecards, competitors, topics, tags, IDs, and date ranges. Example: &audiences[]=everyone&battlecards[]=Sales&createdAfter=2024-01-01T00:00:00Z. You can combine multiple filters using the & separator.

    This endpoint uses pagination to handle large datasets efficiently. The endpoint automatically fetches additional pages using incrementing page numbers, ensuring all Cards matching your filters are retrieved. For more information about the Extract Cards endpoint, refer to the Klue API Documentation.

    Extract Battlecards

    This endpoint returns metadata about published battlecards including structure, competitor associations, and card IDs. Use this endpoint to get context before fetching card content. Use this endpoint when you need to extract battlecard metadata for analysis, reporting, or integration with other systems.

    • Optionally, enter the page number for pagination in the Page Number field. The default value is 1. This endpoint uses pagination to handle large datasets efficiently.
    • Optionally, enter the number of Battlecards to return per page in the Results Per Page field. The default value is 100. You can adjust this value based on your needs and API rate limits.
    • Optionally, enter filters as a query string in the Optional Filters field. Filters can include IDs, competitors, creation dates, and other criteria. Example: &ids[]=123&competitors[]=CompanyX&createdAfter=2024-01-01T00:00:00Z. You can combine multiple filters using the & separator.

    This endpoint returns battlecard metadata including structure, competitor associations, and card IDs. Use the "Extract Cards" endpoint to retrieve the actual card content. For more information about the Extract Battlecards endpoint, refer to the Klue API Documentation.

    Usage Data - Events

    This endpoint returns user event activity logs (card views, clicks, actions) from your Klue workspace. Updated daily at 00:00 UTC with a 3-day delay. Use this endpoint when you need to extract usage analytics, track user engagement, or analyze battlecard performance.

    • Enter the date for usage data in ISO 8601 format (YYYY-MM-DD) in the Date (Required) field. Example: 2024-10-01. The default value is {now-3dd}, which retrieves data from 3 days ago. Data is updated daily at 00:00 UTC with a 3-day delay, so ensure you're requesting data that is at least 3 days old.

    This endpoint returns user event activity logs including card views, clicks, and actions. The data is updated daily at 00:00 UTC with a 3-day delay, so recent data may not be immediately available. For more information about the Usage Data - Events endpoint, refer to the Klue API Documentation.

    Usage Data - Sessions

    This endpoint returns user session logs (entry page, exit page, session duration) from your Klue workspace. Updated daily at 00:00 UTC with a 3-day delay. Use this endpoint when you need to extract session analytics, track user behavior, or analyze workspace usage patterns.

    • Enter the date for usage data in ISO 8601 format (YYYY-MM-DD) in the Date (Required) field. Example: 2024-10-01. The default value is {now-3dd}, which retrieves data from 3 days ago. Data is updated daily at 00:00 UTC with a 3-day delay, so ensure you're requesting data that is at least 3 days old.

    This endpoint returns user session logs including entry page, exit page, and session duration. The data is updated daily at 00:00 UTC with a 3-day delay, so recent data may not be immediately available. For more information about the Usage Data - Sessions endpoint, refer to the Klue 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​

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

    • GET: For retrieving data from the API (most Klue endpoints use GET)

API Endpoint URL​

  1. Enter the URL of the Klue 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. Klue API endpoints typically follow the pattern https://app.klue.com/extract/{resource}.json for extraction endpoints or https://api.klue.com/connect/reports/{resource}.json for usage data endpoints.

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. Klue API endpoints require Bearer token authentication in the Authorization header.

Path to Data​

Optional

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 Cards, the API will typically return card data along with pagination metadata. By entering the path to the relevant data, you can configure Nexla to extract the specific cards you need.

Path to Data is essential when 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. For Klue API responses, common paths include $ for the entire response or $.results for results arrays.

  • 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., $.results to access the results array).
    Path to Data Example:

    If the API response is in JSON format and includes a results array that contains the Cards, the path to the response would be entered as $.results or $ for the entire response.

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.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization, Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. For Klue, the Authorization header with Bearer token is automatically included from your credential.

Endpoint Testing​

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