Skip to main content

Breezometer Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow data flow that sends data to a Breezometer location.
breezometer_api.png

Breezometer

Create a Breezometer Destination​

  1. Click the + icon on the Nexset that will be sent to the Breezometer destination, and select the Send to Destination option from the menu.

  2. Select the Breezometer connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Breezometer account, and click Next; or, create a new Breezometer credential for use in this flow.

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

    Breezometer destinations can also be configured manually, allowing you to send data to Breezometer endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to Breezometer Insights endpoints. Each template is designed specifically for the corresponding Breezometer endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Calculate Cleanest Route

    This endpoint posts one or more candidate routes (each a sequence of geographic points) to the BreezoMeter Insights Engine and returns a cleanliness score (0–100) for each route based on the air quality the route is exposed to. Use it to power health-aware routing — for example, surfacing the lowest-pollution walking, cycling, or driving option in a mobility application.

    • The full record is sent as the JSON body of POST /insights/v1/cleanest-route. Use the Nexla transform layer to shape each upstream record into the request payload expected by BreezoMeter, including the list of candidate routes and the points that define each route.
    • Each route should consist of an ordered list of lat/lon points along the path. Routes that share start and end points but differ in geometry can be compared against each other directly.
    • The response includes a cleanliness score for each submitted route along with summary air-quality statistics across the route geometry.

    For the full request payload reference (route structure, optional features, and supported transport modes), see the BreezoMeter Cleanest Route documentation.

    Submit Environmental Alerts Request

    This endpoint submits a batch of monitored user locations to the BreezoMeter Environmental Alerts Insights Engine. The Insights Engine evaluates current and forecast environmental conditions (air quality, pollen, weather, wildfires) against each location and asynchronously returns alert notifications to a webhook URL registered against your BreezoMeter account.

    • The full record is sent as the JSON body of POST /insights/v1/environmental-alerts. Use the Nexla transform layer to shape each upstream record into the request payload expected by BreezoMeter — typically a list of user identifiers, their locations, and the alert categories they have subscribed to.
    • Alert notifications are not returned in the synchronous response — they are pushed to the webhook URL configured for your BreezoMeter account. The synchronous response acknowledges that the submission was accepted for processing.

    Before activating this destination, confirm that an Environmental Alerts webhook URL is configured for your BreezoMeter API key. For details on the webhook payload format and the supported alert categories, see the BreezoMeter Environmental Alerts API documentation.

Configure Manually​

Breezometer destinations can be manually configured to send data to any valid Breezometer API endpoint. Manual configuration provides maximum flexibility for endpoints not covered by pre-built templates or when custom payload shaping is required.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Breezometer API after each call to a new Nexla webhook data source — useful for capturing cleanliness scores or alert submission acknowledgements as a downstream Nexset.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Breezometer API from the Method pulldown menu. Breezometer Insights destinations use POST.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Breezometer API from the Content Format pulldown menu. Breezometer Insights endpoints expect a JSON request body, so choose JSON. Nexla will automatically convert the data to the selected format for each API call.

API Endpoint URL​

  1. Enter the URL of the Breezometer API endpoint to which you want to send the Nexset data in the URL field. Breezometer Insights URLs are rooted at https://api.breezometer.com/insights/v1/ (for example, https://api.breezometer.com/insights/v1/cleanest-route or https://api.breezometer.com/insights/v1/environmental-alerts).

The Breezometer credential automatically appends the API key as the key URL parameter on every request, so it does not need to be included in the URL.

Request Headers​

Optional

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

    You do not need to include any headers already present in the credentials. The Content-Type: application/json header is set automatically when the JSON content format is selected.

Exclude Attributes from the Call​

Optional

  • If any record attributes in the Nexset should be omitted when sending data to this Breezometer destination, select the attributes from the Exclude Attributes pulldown menu. Use this to strip internal tracking fields or staging columns that should not be included in the Breezometer request payload.

  • Any number of attributes can be selected for exclusion, and all excluded attributes will be shown in the field. To remove an attribute from the list, click the X icon next to the attribute name.

Record Batching​

Optional

  1. If records should be sent to this destination in batched API calls, check the box next to Would you like to batch your records together? to enable record batching. Batching is useful for Environmental Alerts submissions when each upstream record represents a single monitored user — grouping multiple users into one request can reduce overhead and stay within rate limits.

  2. Enter the maximum number of records that should be batched together in a single API call in the Batch Size field. By default, this value is set to 100.

  3. Select the algorithm that will be used to group records into batches from the Grouping Algorithm pulldown menu. The sample request shown in the panel on the right will be updated to reflect the current batching settings.

Response Webhook​

Optional

Nexla can automatically send the response received from the Breezometer API after each call to a new Nexla webhook data source. This is particularly useful for the Cleanest Route endpoint — the cleanliness scores returned for each submitted route can be captured into a downstream Nexset for analytics or for surfacing back to a mobility application.

  • To enable this option, check the box next to Would you like to process the API response as a Nexla Webhook source?.

Sample Request Payload​

Sample request payloads containing a portion of the Nexset data that will be sent to the Breezometer API endpoint based on the current settings are shown in the Sample Payload panel on the right. These samples can be referenced to ensure that the destination and request settings are correctly configured.

  • Click on a sample request payload to expand it and view the complete payload content.

  • Sample payloads are automatically updated with each setting change, making it easy to verify that changes achieve the desired effect.

Endpoint Testing (Manual Configuration)​

After all endpoint settings have been configured, Nexla can send a test payload to the Breezometer API to ensure that the destination is configured correctly.

  1. To send a test payload, select the Test button at the top of the Sample Payload panel, and click on a listed sample payload to expand it.

  2. If any modifications to the sample payload are needed, make the necessary changes directly within the sample window.

  3. Click the Send Test Data button at the top of a sample payload to send the test payload to the Breezometer API using the current settings.

Save & Activate the Destination​

  • Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To begin sending data to the configured Breezometer endpoint, open the destination resource menu, and select Activate.

    The Nexset data will not be sent to Breezometer until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.