Sign in
Data Flows

Data Flows Search

Authorization scope: data flow:list

This endpoint searches for data flows for a specific account_id and environment_id, pagination is supported

get/v1/accounts/{account_id}/environments/{environment_id}/rivers_search

Path parameters

account_idstring required
environment_idstring required

Query parameters

pageinteger

The current page number in the paginated list.

The current page number in the paginated list.

items_per_pageinteger

The number of items per page in the paginated list.

The number of items per page in the paginated list.

group_idstring[] nullable

The river group id

The river group id

[
  "5f5b17b0a10e07a4ff4c33"
]
schedule'all' | 'scheduled' | 'unscheduled'

River schedule status enum

The river schedule status

river_status'active' | 'disabled' | 'suspended'

River status enum for search, includes suspended state. Unlike RiverStatusEnum, this enum includes SUSPENDED which is determined by the presence of suspended.suspension_date field on the river object.

The river status

interface_type'all' | 'new'

River interface type enum. The 'new' represents v2 rivers

Classic or API V2

sort_by'river_date_updated' | 'group_name' | 'river_name'

The river search sort by filter enum provide all the sort by options.

The river sort by filter

sort_order'desc' | 'asc'

Sorting can be either asc or desc, used in the api-service

The river sort order filter

search_querystring
namestring

The river type

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

pageinteger

The page number

current_page_sizeinteger required

The current page size

total_itemsinteger

The total number of entities fetched

account_idstring required

The account id

environment_idstring required

The environment id

items_per_pageinteger required

The number of items per page.

{"stackTrail":"components:schemas:RiverSearchResponse:properties:request","oasType":"schema","type":"unknown","title":"Request","description":"the original search request"}

Example response

{
  "items": [
    {
      "name": "river_name",
      "group_name": "river_group_1",
      "group_id": "62e7f4352c13160013dc39be",
      "river_schedulers": [
        "0 * * * *",
        "0 0 1 * *"
      ],
      "datasource_id": "mysql",
      "target_type": "snowflake",
      "last_user_name_modified": "user_name",
      "river_cross_id": "5f7d4270fdca16cac18261",
      "last_updated_at": "2021-01-01T00:00:00.000Z",
      "description": "CDC River MySql -> Snowflake to be used by the BI team",
      "is_api_v2": true,
      "created_at": "2021-01-01T00:00:00.000Z",
      "source_task_connection_name": "connection_name",
      "match_reason": "river_name=river1",
      "suspended": {
        "notification_date": "2025-01-01T00:00:00",
        "suspension_date": "2025-01-08T00:00:00"
      }
    }
  ]
}