Skip to main content

Lattice Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Lattice source.
lattice.png

Lattice

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

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

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

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

    Fetch Object Lists

    Fetch Object Lists

    • Select the type of Lattice API object you wish to fetch from the Object Type pulldown menu. Available object types include: Departments, Feedbacks, Goals, Review Cycles, Tags, and Users. The default value is "users".
    • The endpoint uses GET requests to https://api.latticehq.com/v1/{object_name}?limit=100 where {object_name} is the object type you selected. The endpoint URL is automatically constructed based on your selection.
    • The endpoint uses pagination (iteration.type: paging.next.token) to retrieve all objects. Pagination uses the startingAfter query parameter with a cursor token to navigate through pages. The limit parameter is set to 100 records per page. The endpoint will automatically fetch all pages until all objects are retrieved.
    • The response data path is $.data[*], which extracts all object records from the data array in the API response. The pagination cursor is extracted from $.endingCursor for the next page token.
    • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

    This endpoint retrieves a list of all objects of the selected type from your Lattice account. The endpoint requires API Key authentication, which is handled automatically by your credential configuration. The API Key is sent in the Authorization: Bearer {api_key} header for all API requests. The endpoint supports pagination through cursor-based pagination using the startingAfter parameter, which allows you to retrieve large lists of objects efficiently. For detailed information about fetching object lists, pagination, and available object types, see the Lattice API reference.

    Fetch One Record

    Fetch One Record

    • Select the type of Lattice API object you wish to fetch from the Object Type pulldown menu. Available object types include: Department, Feedback, Goal, Question, Reviewee, Task, and User. The default value is "user".
    • Enter the ID of the specific object you wish to fetch in the Record ID field. This is the unique identifier for the object in your Lattice account. You can obtain record IDs from the "Fetch Object Lists" endpoint or from your Lattice account dashboard.
    • The endpoint uses GET requests to https://api.latticehq.com/v1/{object_name}/{record_id} where {object_name} is the object type you selected and {record_id} is the Record ID you specified. The endpoint URL is automatically constructed based on your selections.
    • The endpoint does not use pagination (iteration.type: static.url), so it will fetch a single record per execution. The response data path is $, which extracts the entire response object.
    • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

    This endpoint retrieves a specific record of the selected type from your Lattice account. The endpoint requires API Key authentication, which is handled automatically by your credential configuration. The API Key is sent in the Authorization: Bearer {api_key} header for all API requests. The Record ID identifies which specific object to retrieve. For detailed information about fetching individual records and available object types, see the Lattice API reference.

Configure Manually​

Lattice data sources can be manually configured to ingest data from any valid Lattice 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 Lattice sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Lattice API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Lattice API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Lattice 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. Lattice API endpoints typically follow the pattern https://api.latticehq.com/v1/{endpoint_path}.

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 API Key authentication, which is handled automatically by your credential configuration. The API Key is sent in the Authorization: Bearer {api_key} header for all API requests. For detailed information about Lattice API endpoints, authentication, and available APIs, see the Lattice API reference.