Skip to main content

Data Source

The GlassFrog API connector enables you to ingest your organization's governance data—including circles, roles, people, accountabilities, projects, actions, and metrics—from GlassFrog into Nexla for reporting, analytics, and integration with other systems. This connector is particularly useful for organizations that want to analyze role distribution, track governance health, or synchronize holacratic structure data with external platforms.

The GlassFrog API connector enables you to ingest your organization's governance data from GlassFrog into Nexla. Follow the instructions below to create a new data flow that ingests data from a GlassFrog API source in Nexla.
glassfrog_api.png

GlassFrog API

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

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

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

    List Role Assignments

    Retrieves all role assignments — person-to-role mappings — in the GlassFrog organization, with optional filtering by circle, role, or person.

    • Sends a GET request to https://api.glassfrog.com/api/v3/assignments with optional filter parameters and returns an array of assignment objects.
    • Response data is located at $.assignments[*].
    • Configure the following parameters: Circle Id — filter by circle ID; Role Id — filter by role ID; Person Id — filter by person ID. All parameters are optional.

    All filter parameters are optional. Omit them to retrieve all role assignments across the organization.

    Get Circle

    Returns the details of a single GlassFrog circle by its ID, including its name, purpose, and parent circle relationship.

    Use the List Circles endpoint to discover valid circle IDs in your organization.

    Get Role

    Returns the details of a single GlassFrog role by its ID, including purpose, domains, and accountabilities.

    Role IDs can be found via the List Role Assignments endpoint or through the GlassFrog web interface.

    Get Person

    Returns the details of a single GlassFrog organization member by their ID, including name, email, and external ID.

    Person IDs can be found via the List Role Assignments endpoint or other GlassFrog endpoints that return linked people data.

    Get Project

    Returns the details of a single GlassFrog project by its ID, including its status, description, and owning role.

    Project IDs can be discovered by retrieving the full list of projects via a custom GET request to https://api.glassfrog.com/api/v3/projects.

    Get Metric

    Retrieves a single GlassFrog metric by its ID, including its description, frequency, and associated role.

    Metric IDs can be found via a list request to https://api.glassfrog.com/api/v3/metrics.

    Get Checklist Item

    Retrieves a single GlassFrog checklist item by its ID, including its description and associated role.

    Checklist item IDs can be found via a list request to https://api.glassfrog.com/api/v3/checklist_items.

    Get Assignment

    Retrieves a single role assignment by its ID, returning the person-to-role mapping for that specific assignment.

    Assignment IDs can be found via the List Role Assignments endpoint.

    List Circles

    Lists all circles in the GlassFrog organization, providing a complete view of the organization's governance structure.

    No parameters are required. Use the returned circle IDs with the Get Circle or List Role Assignments endpoints for further data retrieval.

    List Actions

    Lists all next-actions and tensions captured in GlassFrog tactical meetings, useful for tracking organizational action items.

    No parameters are required. Each action includes its description, status, and owning person and role.

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​

GlassFrog API sources can also be configured to ingest data from any valid GlassFrog API v3 endpoint. All GlassFrog API v3 endpoints use the base URL https://api.glassfrog.com/api/v3/ and return JSON responses. Configuration options allow sources to be fully customized for any use case—including fetching circles, roles, people, projects, actions, checklist items, and metrics.

First, select the method that will be used for calls to the GlassFrog API from the Method pulldown menu. The GlassFrog API v3 is a read-focused API; the most common method for data ingestion is:

  • GET: For retrieving governance data such as circles, roles, people, projects, actions, and metrics.

API Endpoint URL​

  1. Enter the URL of the GlassFrog API v3 endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL, including the https:// protocol. All GlassFrog API v3 URLs begin with https://api.glassfrog.com/api/v3/.

    Common GlassFrog API v3 endpoint paths include:

    • https://api.glassfrog.com/api/v3/circles — Retrieves all circles in the organization, including their names, purposes, and parent circles.

    • https://api.glassfrog.com/api/v3/roles — Retrieves all roles defined in the organization, along with associated accountabilities and domains.

    • https://api.glassfrog.com/api/v3/people — Retrieves all members of the organization with their contact details and role assignments.

    • https://api.glassfrog.com/api/v3/projects — Retrieves projects tracked within GlassFrog, including status and ownership.

    • https://api.glassfrog.com/api/v3/actions — Retrieves actions (next steps) created in tactical meetings.

    • https://api.glassfrog.com/api/v3/checklist_items — Retrieves recurring checklist items used in tactical meetings.

    • https://api.glassfrog.com/api/v3/metrics — Retrieves metrics tracked in tactical meetings.

    • https://api.glassfrog.com/api/v3/triggers — Retrieves triggers associated with roles and circles.

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. For a full reference of available endpoints and supported query parameters, refer to the GlassFrog API documentation and the GlassFrog API v3 Postman reference.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.

Date/Time macros are useful when querying GlassFrog endpoints that support filtering by date, such as filtering actions or projects updated after a specific time.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful when you need to fetch GlassFrog data for a specific circle or role ID that was retrieved from another Nexla data source. For example, you can dynamically build a URL like https://api.glassfrog.com/api/v3/circles/{'{circle_id}'}/roles using a circle ID from a prior lookup.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data returned by the 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. GlassFrog API v3 responses are JSON objects whose top-level key matches the resource name (for example, circles, roles, people). Specifying the path to this array ensures Nexla treats each element as a separate record.

For example, a request to https://api.glassfrog.com/api/v3/circles returns a JSON object with a circles key containing the array of circle records, along with linked data and metadata. By specifying $.circles[*] as the path to data, Nexla will treat each circle object as an individual record.

Path to Data is essential for GlassFrog API responses, which wrap records in a named array. Without specifying the correct path, Nexla may not be able to properly parse and organize the 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., $.circles[*] to access the array of circles, or $.roles[*] to access the array of roles).
    Path to Data Example:

    For a request to the /circles endpoint, the JSON response contains a top-level array named circles. Enter $.circles[*] as the path to data to treat each circle object as a separate record.

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 and 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

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. GlassFrog API v3 responses often include a linked object containing referenced data (such as people linked to roles) that may be useful to preserve alongside the primary records.

Metadata paths are useful for capturing the linked object in GlassFrog API responses, which contains referenced resource data (people, circles, roles) that applies to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata (for example, $.linked to capture the linked resource data included in GlassFrog API responses).

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers and corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2).

    You do not need to include any headers already present in the credentials. The GlassFrog API authentication header (X-Auth-Token) is handled automatically by Nexla based on your credential configuration.

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 and 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 GlassFrog API 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.