API Reference
  • 1 Minute to read
  • Dark
  • PDF

API Reference

  • Dark
  • PDF

Article Summary


This Rivery API Reference Guide provides a complete overview of the API and its capabilities. By using the API, users can automate and streamline their data management processes.


To authenticate API requests, a unique API Token must be included in the header of each request.

The migration of API endpoints from the current API to the new one is currently underway. Before using a specific endpoint, please check if it is available in the new API documentation. If it is not yet available, you can use the endpoint from the current API documentation.

Current API Documentation

In this Current API documentation, the following API endpoints are outlined:

  • Data Connectors - Get Datasource List, Get the Datasource List by Segment.
  • Connection - Connection Types and Properties, Connection Management, Connection Key Files, OAuth2 New Credentials Requst, Create a Shareable Connection Link.
  • Rivers Managemnet - Get River, Get Sub Rivers Properties, Execute an Existing River or Sub River, Create New Sub River for River, Get Data From Specific Sub River ID.
  • Run Rivers - Execute an Existing River or Sub River, Check the Execution Status of a River.
  • Results - Create Pull Requests for Results, Get Results ID.

New API Documentation

In this New API documentation, the following API endpoints are outlined:

  • Authorization - Rivery API Token, Scopes.
  • Rivers - Run River, Run Sub River, Delete River, Get River Variables, Update River Variable.
  • Activities - Get Activities Statistic, Get River Activities Run Groups, Get River Activities Sub Rivers, Get River Activities Runs.
  • DataFrames - Get Dataframes, Add Dataframe, Get Dataframe by Name, Update Dataframe, Delete Dataframe, Download Dataframe, Clear Dataframe Values.
  • Audit Events- List Audit Events, Get Audit Event.

Was this article helpful?