Waiting for engine...
Skip to main content

Legacy Data Integration API Reference (1.0.0) - SubRiversProperties

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration.

Sub Rivers Properties

Get the properties needed for every sub river, by river_id, or by datasource_type.

Get Sub Rivers Properties by Datasource ID

Get Sub Rivers Properties by Datasource ID

Authorizations:
BearerToken
query Parameters
datasource_id
string
Example: datasource_id=klaviyo

Responses

Response Schema: application/json
datasource_id
string
Array of objects

Request samples 

curl --location
--request GET 'https://console.rivery.io/api/rivers/properties/subrivers?datasource_id=' \
--header 'Authorization: Bearer <token>'

Response samples

Content type
application/json
{
  • "datasource_id": "klaviyo",
  • "properties": [
    • {
      }
    ]
}

Get Sub Rivers Properties by River ID

Get Sub Rivers Properties by River ID

Authorizations:
BearerToken
path Parameters
riverId
required
string
Example: 5faa7bd17bedeb66f4c287c7

The river ID to reference for

Responses

Response Schema: application/json
river_id
string

the river id

river_name
string

the river name

river_type
string

The river type (src_to_trgt, logic, action)

object (RiverAllowedProperties)
object (RiverAllowedProperties)

Request samples 

curl --location -g
--request GET 'https://console.rivery.io/api/rivers/{{riverId}}/properties' \
--header 'Authorization: Bearer <token>'

Response samples

Content type
application/json
{
  • "river_id": "string",
  • "river_name": "string",
  • "river_type": "string",
  • "source": {
    • "datasource_id": "klaviyo",
    • "properties": [
      ]
    },
  • "target": {
    • "datasource_id": "klaviyo",
    • "properties": [
      ]
    }
}