Ride icon

Ride

Interact with Ride service API

Actions7

Overview

The node integrates with the Ride service API to retrieve and manipulate ride-related data such as users, events, routes, trips, and synchronization of changes. Specifically, for the Route resource with the Get Routes operation, it fetches a paginated list of routes from the Ride API.

This node is useful in scenarios where you want to automate the retrieval of cycling or running route data stored in the Ride service, for example:

  • Importing a list of available routes into a workflow for further processing or analysis.
  • Synchronizing route data regularly to keep an external database up to date.
  • Combining route data with other datasets for reporting or visualization.

Practical example: You could use this node to get all routes on page 1, then pass the data downstream to filter routes by distance or elevation gain, or to generate maps or statistics.

Properties

Name Meaning
Page Number Page number for pagination; specifies which page of routes to retrieve from the API. Default is 1.

Output

The output JSON structure for the Get Routes operation is an array of route objects transformed by a utility function. Each item represents a route with its associated metadata and details as returned by the Ride API.

The exact fields depend on the API response and the transformation applied but typically include route identifiers, names, descriptions, distances, elevations, and other route-specific data.

No binary data is output for this operation.

Example output (simplified):

{
  "routes": [
    {
      "id": 123,
      "name": "Morning Ride",
      "distance": 25.4,
      "elevation_gain": 300,
      ...
    },
    {
      "id": 124,
      "name": "Evening Loop",
      "distance": 15.2,
      "elevation_gain": 150,
      ...
    }
  ]
}

Dependencies

  • Requires an API key credential for authenticating requests to the Ride service API.
  • The base URL used is https://ridewithgps.com.
  • No additional environment variables are required for this operation.

Troubleshooting

  • Common issues:

    • Pagination errors if the page number is out of range or invalid.
    • Authentication failures if the API key credential is missing or invalid.
    • Network connectivity issues preventing access to the Ride API.
  • Error messages:

    • "Unknown routes operation: getRoutes": This indicates an internal error or misconfiguration; ensure the operation name is correctly set.
    • HTTP errors from the API (e.g., 401 Unauthorized) usually mean the API key is incorrect or expired.
  • Resolutions:

    • Verify that the API key credential is properly configured and has necessary permissions.
    • Check the page number input to ensure it is a positive integer.
    • Confirm network connectivity and that the Ride API endpoint is reachable.

Links and References

Discussion