REST API

Last updated on Dec 19, 2022

Hevo allows you to bring data from various Sources through its native connectors. However, for situations where you need to bring data from multiple different applications or from an in-house REST API, you can use the REST API Source.

For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, you are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data. Read Hevo Managed Google BigQuery.


Troubleshooting the Rest API

Refer to this section for possible causes for some of the errors while testing the API.

  • Error: Failed to get a response

    Reason: The specified URL is incorrect, causing the API to fail.

  • Error: Failed to parse response

    Reason: The specified data root is incorrect, due to which, the API call fails to locate the root of the data in the API response.

  • Error: HTTP ERROR 404

    Reason: A private API is configured with Hevo, but Hevo’s IP addresses are not whitelisted.

    Resolution: Whitelist the Hevo IP address for your region for private APIs to work with Hevo.


Limitations



Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Dec-19-2022 2.04 Updated the section, Configuring REST API as a Source to add information about enhanced data root auto-suggestion functionality.
Nov-23-2022 NA Added section, Limitations.
Nov-11-2022 NA Updated section, Troubleshooting the Rest API to include the troubleshooting scenario for Error 404.
Sep-05-2022 NA Updated the See Also section to:
- Add a reference to the REST API FAQs page.
- Remove the reference to the pagination-related FAQ.
Aug-24-2022 1.96 Updated section, Configuring REST API as a Source to add information about data root auto-suggestion by Hevo.
May-10-2022 1.88 - Added information about authentication using OAuth 2.0 protocol.
- Removed section, Testing the API Response.
Dec-20-2021 1.78 Updated the screenshot in step 4 of the section, Configuring REST API as a Source to to reflect the latest UI changes.
Nov-09-2021 1.75 Updated:
- Step 4 in the section, Configuring REST API as a Source to explain the API behavior in case No Pagination is selected.
- The See Also section to add a link to a pagination-related FAQ.
Oct-25-2021 NA Added the Pipeline frequency information in the Data Replication section.
Added the See Also section.
Oct-04-2021 1.73 Updated step 4 in the section, Configuring REST API as a Source to to add:
- A new pagination option, Offset and Limit.
- An option Is the next page URL present in the response? in Session-based pagination.
- Screenshots for each pagination option.
Sep-20-2021 1.72 Updated step 4 in the section, Configuring REST API as a Source to add:
- The Request Body property for the POST method.
- A note in the Data Root property about expected JSONPath expressions.
Apr-06-2021 1.60 Added the following sections:
- Testing the REST API.
- Troubleshooting the REST API.
Updated the section Configuring REST API as a Source to include the field Extract from last record in response.

Tell us what went wrong