Boomi Data Integration API Reference (1.0.0) - Activities

Toggle Pane

• Activities
  • getGet Activities Statistic
  • getGet Data Flow Activities Statistic
  • getGet Data Flow Activities Targets
  • getList Data Flow Activities Run Groups
  • getGet Data Flow Activities Run Groups
  • getGet Data Flow Activities Sub Data Flows
  • getGet Data Flow Activities Runs
  • getGet Data Flow Activities Run
  • getGet Data Flow Activities Run Tasks
  • getGet Data Flow Activities Run Logic Steps
  • getGet Activities Logic Variables
  • getGet Activities Logic Step Log
  • getGet Activities
  • getGet Run Logs
• MCP
  • getGet Data Flow Activities Runs
  • getGet Data Flow Activities Run
  • getGet Run Logs

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Find out more about Data Integration

Activities

Get the Boomi Data Integration activities data with various of GET operations

Get Activities Statistic

Authorization scope: activity:list

Get environment's activity statistics.

---

The statistics include how many units(RPU) were consumed, and how many runs ended with each status.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	Array of Status (strings) or Status (null) (Status) A list of statuses to filter
	Array of Group Id (strings) or Group Id (null) (Group Id) The ID of the group to filter
is_scheduled	string (Is Scheduled) Enum: "true" "false" A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned
search	string (Search) Get statistics for rivers that has the search query in their name
	(Array of River Type (RiverTypeInternalEnum (string) or RiverTypeEnum (string))) or River Type (null) (River Type) The river type

Responses

Response Schema: application/json

account_id required	string (Account Id)
environment_id required	string (Environment Id)
total_units required	number (Total Units) Total RPU (units)
total_rpu required	number (Total Rpu) Total RPU
running required	integer (Running)
canceled required	integer (Canceled)
pending required	integer (Pending)
failed required	integer (Failed)
succeeded required	integer (Succeeded)
skipped required	integer (Skipped)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/activities_statistics

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/activities_statistics

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "string",
• "environment_id": "string",
• "total_units": 2.1,
• "total_rpu": 2.1,
• "running": 0,
• "canceled": 0,
• "pending": 0,
• "failed": 0,
• "succeeded": 0,
• "skipped": 0

}

Get Data Flow Activities Statistic

Authorization scope: activity:list

Get data flow's activity statistics (summary).

---

The statistics include how many units(RPU) were consumed, and how many runs ended with each status

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	Array of Status (strings) or Status (null) (Status)

Responses

Response Schema: application/json

account_id required	string (Account Id)
environment_id required	string (Environment Id)
total_units required	number (Total Units) Total RPU (units)
total_rpu required	number (Total Rpu) Total RPU
running required	integer (Running)
canceled required	integer (Canceled)
pending required	integer (Pending)
failed required	integer (Failed)
succeeded required	integer (Succeeded)
skipped required	integer (Skipped)
river_cross_id required	string (River Cross Id)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_statistics

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_statistics

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "string",
• "environment_id": "string",
• "total_units": 2.1,
• "total_rpu": 2.1,
• "running": 0,
• "canceled": 0,
• "pending": 0,
• "failed": 0,
• "succeeded": 0,
• "skipped": 0,
• "river_cross_id": "string"

}

Get Data Flow Activities Targets

Authorization scope: activity:list

Get data flow's activity targets (table names) in a specific time frame for specific data flow and their status.

---

This endpoint should be used for multi table data flows.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	Run Group Id (string) or Run Group Id (null) (Run Group Id) Filter by the run group ID
	Sub River Id (string) or Sub River Id (null) (Sub River Id) Filter by the sub river ID
	Array of Status (strings) or Status (null) (Status) A list of statuses. Only targets with those statuses will be returned
sort_by	string (Sort By) Default: "last_run" Enum: "units" "last_run" "table_name" Indicates by which parameter to sort the targets
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" Sorting can be either asc or desc, used in the api-service

Responses

Response Schema: application/json

required	Array of objects (Items)
account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_targets

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_targets

Response samples

• 200
• 422

Content type

application/json

{

• "items": [

  • {

    • "target_name": "string",
    • "status": "pending",
    • "units": 2.1,
    • "rpu": 2.1,
    • "last_run": "2019-08-24T14:15:22Z"

    }

  ],
• "account_id": "string",
• "environment_id": "string",
• "river_cross_id": "string"

}

List Data Flow Activities Run Groups

Authorization scope: activity:list

Get list of run groups that occurred in a specific time frame for specific data flow and their status.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	Target Name (string) or Target Name (null) (Target Name) Filter by the target table name
	Sub River Id (string) or Sub River Id (null) (Sub River Id) Filter by the sub river ID
status	Array of strings (Status) Items Enum: "partially succeeded" "pending" "canceled" "succeeded" "failed" "running" "skipped" A list of statuses. Only run groups with this statuses will be returned.
cache_context_id	string (Cache Context Id) Cache context id is an internal query parameter for cache purposes
page	integer (Page) >= 1 Default: 1
sort_by	string (Sort By) Default: "last_run" Enum: "units" "last_run" "max_duration" Activities sort properties in the UI.
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" Sorting can be either asc or desc, used in the api-service
items_per_page	integer (Items Per Page) [ 1 .. 200 ] Default: 50

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
river_cross_id required	string (River Cross Id)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "run_group_id": "201dcf8182ad4a59868cb41b957fdc8d",
    • "status": "string",
    • "units": 2.1,
    • "rpu": 2.1,
    • "max_duration_in_milliseconds": 0,
    • "run_date_epoch_milliseconds": 0,
    • "run_date_utc": "2019-08-24T14:15:22Z",
    • "run_end_date_epoch_milliseconds": 1658774335000,
    • "run_end_date_utc": "2022-07-25T18:38:55.640Z",
    • "trigger_name": "ui",
    • "trigger_chain": [

      • {

        • "trigger_name": "scheduled"

        },
      • {

        • "run_id": "R1",
        • "trigger_name": "logic"

        }

      ]

    }

  ],
• "river_cross_id": "string"

}

Get Data Flow Activities Run Groups

Get a specific run group id

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_group_id required	string (Run Group Id)

Responses

Response Schema: application/json

run_group_id required	string (Run Group Id) The run group id
status required	string (Status)
required	Units (number) or Units (null) (Units) Total RPU (units)
required	Rpu (number) or Rpu (null) (Rpu) Total RPU
run_date_epoch_milliseconds required	integer (Run Date Epoch Milliseconds)
run_date_utc required	string <date-time> (Run Date Utc)
required	Run End Date Epoch Milliseconds (integer) or Run End Date Epoch Milliseconds (null) (Run End Date Epoch Milliseconds) The end epoch in milliseconds.
required	Run End Date Utc (string) or Run End Date Utc (null) (Run End Date Utc) The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms
running required	integer (Running)
canceled required	integer (Canceled)
pending required	integer (Pending)
failed required	integer (Failed)
succeeded required	integer (Succeeded)
skipped required	integer (Skipped)
	Max Duration In Milliseconds (integer) or Max Duration In Milliseconds (null) (Max Duration In Milliseconds)
	TriggerName (string) or null The mechanism that started the run. Empty for runs of an account that does not track triggers
	Array of TriggerChain (objects) or null The trigger events leading back to the act that started the whole run tree, oldest first

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups/{run_group_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups/{run_group_id}

Response samples

• 200
• 422

Content type

application/json

{

• "run_group_id": "201dcf8182ad4a59868cb41b957fdc8d",
• "status": "string",
• "units": 2.1,
• "rpu": 2.1,
• "max_duration_in_milliseconds": 0,
• "run_date_epoch_milliseconds": 0,
• "run_date_utc": "2019-08-24T14:15:22Z",
• "run_end_date_epoch_milliseconds": 1658774335000,
• "run_end_date_utc": "2022-07-25T18:38:55.640Z",
• "trigger_name": "ui",
• "trigger_chain": [

  • {

    • "trigger_name": "scheduled"

    },
  • {

    • "run_id": "R1",
    • "trigger_name": "logic"

    }

  ],
• "running": 0,
• "canceled": 0,
• "pending": 0,
• "failed": 0,
• "succeeded": 0,
• "skipped": 0

}

Get Data Flow Activities Sub Data Flows

Authorization scope: activity:list

Get list of sub data flows that ran in a specific time frame.

---

Additional filters can be added such as target name or run group id.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
target_name	string (Target Name) Filter by the target table name
run_group_id	string (Run Group Id) Filter by the run group ID

Responses

Response Schema: application/json

required	Array of objects (Items)
account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_sub_rivers

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_sub_rivers

Response samples

• 200
• 422

Content type

application/json

{

• "items": [

  • {

    • "sub_river_id": "string",
    • "sub_river_name": "string"

    }

  ],
• "account_id": "string",
• "environment_id": "string",
• "river_cross_id": "string"

}

Get Data Flow Activities Runs

Authorization scope: activity:list

Get list of runs for a specific data flow in a specific time frame.

---

This endpoint return information about the runs.

---

📖 Instructions for usage

list_runs

List data runs for a data flow within a time range.

start_time and end_time must be ISO 8601 format, e.g. "2026-05-25T00:00:00".
Each item includes run_id, status, start_date_utc, end_date_utc, error_description.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	Target Name (string) or Target Name (null) (Target Name) Filter by the target table name
	Run Group Id (string) or Run Group Id (null) (Run Group Id) Filter by the run group ID
	Sub River Id (string) or Sub River Id (null) (Sub River Id) Filter by the sub river ID
page	integer (Page) >= 1 Default: 1
items_per_page	integer (Items Per Page) [ 1 .. 200 ] Default: 20
sort_by	string (Sort By) Default: "start_time" Enum: "units" "start_time" "table_name" Indicates by which parameter to sort the runs
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" Sorting can be either asc or desc, used in the api-service
cache_context_id	string (Cache Context Id) Cache context id is an internal query parameter for cache purposes

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
river_cross_id required	string (River Cross Id)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
    • "river_cross_id": "507f191e810c19729de860ea",
    • "datasource_id": "mysql",
    • "error_description": "error",
    • "units": 2.1,
    • "rpu": 2.1,
    • "run_group_id": "201dcf8182ad4a59868cb41b957fdc8d",
    • "status": "pending",
    • "source_name": "mysql",
    • "target_name": "table",
    • "start_date_utc": "2022-07-25T18:38:55.640Z",
    • "start_date_in_milliseconds": 1658774335000,
    • "end_date_utc": "2022-07-25T18:38:55.640Z",
    • "end_date_in_milliseconds": 1658774335000,
    • "sub_river_id": "507f191e810c19729de860ea",
    • "is_sub_river_run": false,
    • "is_high_frequency": false,
    • "pricing_category": "string",
    • "trigger_name": "ui",
    • "triggered_by_run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
    • "trigger_chain": [

      • {

        • "trigger_name": "scheduled"

        },
      • {

        • "run_id": "R1",
        • "trigger_name": "logic"

        }

      ]

    }

  ],
• "river_cross_id": "string"

}

Get Data Flow Activities Run

Authorization scope: activity:list

Get a specific run details.

---

📖 Instructions for usage

run_data_flow, get_run

run_data_flow

Trigger an immediate run of a data flow.

By default returns instantly with the run_id (do NOT poll). Set wait=True to block
until the run reaches a terminal state (success/failed/cancelled) and return the
final run object — useful for tests/automation so you don't sleep blindly.

Before calling this, make sure ALL source tables are configured in a single
set_data_flow_source_tables call — one data flow syncs multiple tables in one run.

Common 400 causes:
  - Data flow not yet activated: call activate_data_flow(wait=True) first.
  - No source tables configured: call set_data_flow_source_tables first.

get_run

Get the status and result of a data flow run by its run_id.

Use the run_group_id returned by run_data_flow as the run_id here.
Status is returned as a plain string: pending, running, success, failed.
Check error_description for failure details.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)

Responses

Response Schema: application/json

run_id required	string (Run Id) The run ID
river_cross_id required	string (River Cross Id) The river cross ID
datasource_id required	string (Datasource Id) The datasource ID
required	Error Description (string) or Error Description (null) (Error Description) The error description if any
units required	number (Units) Total RPU (units)
rpu required	number (Rpu) Total RPU
run_group_id required	string (Run Group Id) The run group id
status required	string (ActivityStatusEnum) Enum: "pending" "canceled" "succeeded" "failed" "running" "skipped" The external status of a run (being used in the api)
source_name required	string (Source Name) The name of the source
start_date_utc required	string <date-time> (Start Date Utc) The start date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms
start_date_in_milliseconds required	integer (Start Date In Milliseconds) The start epoch in milliseconds.
required	End Date Utc (string) or End Date Utc (null) (End Date Utc) The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms
required	End Date In Milliseconds (integer) or End Date In Milliseconds (null) (End Date In Milliseconds) The end epoch in milliseconds.
is_sub_river_run required	boolean (Is Sub River Run) A flag that indicates whether this run is of a sub river or not
	Target Name (string) or Target Name (null) (Target Name) The target table name
	Sub River Id (string) or Sub River Id (null) (Sub River Id) The sub river id
	Is High Frequency (boolean) or Is High Frequency (null) (Is High Frequency) Default: false A flag that indicates whether this run is high frequency or not
	Pricing Category (string) or Pricing Category (null) (Pricing Category) The RPU policy rule object for calculating an RPU
	TriggerName (string) or null The mechanism that started the run. Empty for runs of an account that does not track triggers
	Triggered By Run Id (string) or Triggered By Run Id (null) (Triggered By Run Id) The run that triggered this one. Empty when the run is the root of its tree
	Array of TriggerChain (objects) or null The trigger events leading back to the act that started the whole run tree, oldest first

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}

Response samples

• 200
• 422

Content type

application/json

{

• "run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
• "river_cross_id": "507f191e810c19729de860ea",
• "datasource_id": "mysql",
• "error_description": "error",
• "units": 2.1,
• "rpu": 2.1,
• "run_group_id": "201dcf8182ad4a59868cb41b957fdc8d",
• "status": "pending",
• "source_name": "mysql",
• "target_name": "table",
• "start_date_utc": "2022-07-25T18:38:55.640Z",
• "start_date_in_milliseconds": 1658774335000,
• "end_date_utc": "2022-07-25T18:38:55.640Z",
• "end_date_in_milliseconds": 1658774335000,
• "sub_river_id": "507f191e810c19729de860ea",
• "is_sub_river_run": false,
• "is_high_frequency": false,
• "pricing_category": "string",
• "trigger_name": "ui",
• "triggered_by_run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
• "trigger_chain": [

  • {

    • "trigger_name": "scheduled"

    },
  • {

    • "run_id": "R1",
    • "trigger_name": "logic"

    }

  ]

}

Get Data Flow Activities Run Tasks

Authorization scope: activity:list

Get data flow's activity specific run tasks.

---

Each run may have multiple tasks. This endpoint returns those tasks details.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)

Responses

Response Schema: application/json

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)
required	Array of any (Items)
units required	number (Units) Total RPU (units)
rpu required	number (Rpu) Total RPU
	Pricing Category (string) or Pricing Category (null) (Pricing Category) The RPU policy rule object for calculating an RPU

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/tasks

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/tasks

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "string",
• "environment_id": "string",
• "river_cross_id": "string",
• "run_id": "string",
• "items": [

  • {

    • "duration": 2000,
    • "error_description": "error",
    • "start_date_utc": "2022-07-25T18:38:55.640Z",
    • "start_date_in_milliseconds": 1658774335000,
    • "end_date_utc": "2022-07-25T18:38:55.640Z",
    • "end_date_in_milliseconds": 1658774335000,
    • "source": "Google Ads",
    • "task_id": "6a23130732304020886bf5f8bfcecfbc",
    • "task_name": "Google Ads To Amazon S3",
    • "task_status": "succeeded",
    • "task_type": "actions",
    • "response_details": [

      • null

      ]

    }

  ],
• "pricing_category": "string",
• "units": 2.1,
• "rpu": 2.1

}

Get Data Flow Activities Run Logic Steps

Authorization scope: activity:list

Get the status of each logic step for a specific run.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)

Responses

Response Schema: application/json

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)
required	object (Steps)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "string",
• "environment_id": "string",
• "river_cross_id": "string",
• "run_id": "string",
• "steps": {

  • "property1": {

    • "is_container": true,
    • "container_type": "run_once",
    • "start_date_utc": "2022-07-25T18:38:55.640Z",
    • "start_date_in_milliseconds": 1658774335000,
    • "end_date_utc": "2022-07-25T18:38:55.640Z",
    • "end_date_in_milliseconds": 1658774335000,
    • "step_status": "succeeded",
    • "loop_iteration_number": 0,
    • "duration": "0:01:23.275006",
    • "step_execution_id": "string",
    • "step_id": "string",
    • "step_index": "string",
    • "error_description": "error",
    • "logicode_statistics": {

      • "logicode_rpu": 0,
      • "logicode_network_mb": 0,
      • "logicode_duration_seconds": 0

      },
    • "block_type": "action"

    },
  • "property2": {

    • "is_container": true,
    • "container_type": "run_once",
    • "start_date_utc": "2022-07-25T18:38:55.640Z",
    • "start_date_in_milliseconds": 1658774335000,
    • "end_date_utc": "2022-07-25T18:38:55.640Z",
    • "end_date_in_milliseconds": 1658774335000,
    • "step_status": "succeeded",
    • "loop_iteration_number": 0,
    • "duration": "0:01:23.275006",
    • "step_execution_id": "string",
    • "step_id": "string",
    • "step_index": "string",
    • "error_description": "error",
    • "logicode_statistics": {

      • "logicode_rpu": 0,
      • "logicode_network_mb": 0,
      • "logicode_duration_seconds": 0

      },
    • "block_type": "action"

    }

  }

}

Get Activities Logic Variables

Authorization scope: activity:list

This endpoint retrieves the values of the logic variables in a specific run. The values are stored for a short period of time and will expire after that time. If the values have expired, an error message will be returned.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)

Responses

Response Schema: application/json

required	Array of objects (Items)
Array account required string (Account) The account of the river env_id required string (Env Id) The environment of the river river_id required string (River Id) The ID of the river name required string (Name) The name of the variable settings required object (Settings) variable settings Value (string) or Array of Value (any) or Value (null) (Value) value of variable

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/variables

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/variables

Response samples

• 200
• 422

Content type

application/json

{

• "items": [

  • {

    • "account": "55fr7d4270fdca16cac18261",
    • "env_id": "55fr7d4270fdca16cac18261",
    • "river_id": "55fr7d4270fdca16cac18261",
    • "name": "credentials",
    • "settings": {

      • "clear_value_on_start": true,
      • "is_encrypted": false,
      • "is_multi_value": false,
      • "is_private": false

      },
    • "value": "1234"

    }

  ]

}

Get Activities Logic Step Log

Authorization scope: activity:list

Get the logs of a python logic step.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)
step_id required	string (Step Id)

query Parameters

iteration_number

integer (Iteration Number) >= 0 Default: 0 The step iteration number

Responses

Response Schema: application/json

logs_url required

string (Logs Url)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps/{step_id}/logs

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps/{step_id}/logs

Response samples

• 200
• 422

Content type

application/json

{

• "logs_url": "string"

}

Get Activities

Authorization scope: activity:list

Get summary of activities for the account and environment summarized by data flow.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	Array of Status (strings) or Status (null) (Status)
	Array of Group Id (strings) or Group Id (null) (Group Id) The ID of the group to filter
is_scheduled	string (Is Scheduled) Enum: "true" "false" A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned
page	integer (Page) >= 1 Default: 1
items_per_page	integer (Items Per Page) [ 1 .. 200 ] Default: 20
	Cache Context Id (string) or Cache Context Id (null) (Cache Context Id) Cache context id is an internal query parameter for cache purposes
search	string (Search) Search for a specific river by river name
sort_by	string (Sort By) Default: "last_run" Enum: "river_name" "last_run" "units" Activities sort properties in the UI.
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" Sorting can be either asc or desc, used in the api-service
	(Array of River Type (RiverTypeInternalEnum (string) or RiverTypeEnum (string))) or River Type (null) (River Type) The river type

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
required	Cache Context Id (string) or Cache Context Id (null) (Cache Context Id)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/activities

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/activities

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "account_id": "string",
    • "environment_id": "string",
    • "cross_id": "string",
    • "river_id": "string",
    • "master_river_id": "string",
    • "river_name": "string",
    • "is_sub_river": true,
    • "is_master_river": true,
    • "is_multi": true,
    • "is_deleted": true,
    • "group_id": "string",
    • "is_scheduled": true,
    • "total_files": 0,
    • "units": 2.1,
    • "rpu": 2.1,
    • "total_size": 0,
    • "last_run": 0,
    • "pending": 0,
    • "failed": 0,
    • "running": 0,
    • "succeeded": 0,
    • "canceled": 0,
    • "datasource_id": "string"

    }

  ],
• "cache_context_id": "string"

}

Get Run Logs

Authorization scope: activity:list

This method fetches the logs for a given run id of a data flow.

---

📖 Instructions for usage

get_run_logs

Download the logs for a specific data flow run as CSV text.

Returns raw CSV content with all log lines for the run.
Logs are only available for runs within the last 2 weeks.
If the response is empty, the data source may not support logs.

Use get_run first to confirm the run exists, then call this to fetch its logs.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)

query Parameters

Array of Additional Services (strings) or Additional Services (null) (Additional Services) Additional services to query

Responses

Response Schema: text/html

string

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logs

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logs

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

MCP

Get Data Flow Activities Runs

Authorization scope: activity:list

Get list of runs for a specific data flow in a specific time frame.

---

This endpoint return information about the runs.

---

📖 Instructions for usage

list_runs

List data runs for a data flow within a time range.

start_time and end_time must be ISO 8601 format, e.g. "2026-05-25T00:00:00".
Each item includes run_id, status, start_date_utc, end_date_utc, error_description.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

start_time required	string <date-time> (Start Time) Examples: start_time=2020-01-01T12:00:00 The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
end_time required	string <date-time> (End Time) Examples: end_time=2020-01-01T12:00:00 The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
	Target Name (string) or Target Name (null) (Target Name) Filter by the target table name
	Run Group Id (string) or Run Group Id (null) (Run Group Id) Filter by the run group ID
	Sub River Id (string) or Sub River Id (null) (Sub River Id) Filter by the sub river ID
page	integer (Page) >= 1 Default: 1
items_per_page	integer (Items Per Page) [ 1 .. 200 ] Default: 20
sort_by	string (Sort By) Default: "start_time" Enum: "units" "start_time" "table_name" Indicates by which parameter to sort the runs
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" Sorting can be either asc or desc, used in the api-service
cache_context_id	string (Cache Context Id) Cache context id is an internal query parameter for cache purposes

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
river_cross_id required	string (River Cross Id)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
    • "river_cross_id": "507f191e810c19729de860ea",
    • "datasource_id": "mysql",
    • "error_description": "error",
    • "units": 2.1,
    • "rpu": 2.1,
    • "run_group_id": "201dcf8182ad4a59868cb41b957fdc8d",
    • "status": "pending",
    • "source_name": "mysql",
    • "target_name": "table",
    • "start_date_utc": "2022-07-25T18:38:55.640Z",
    • "start_date_in_milliseconds": 1658774335000,
    • "end_date_utc": "2022-07-25T18:38:55.640Z",
    • "end_date_in_milliseconds": 1658774335000,
    • "sub_river_id": "507f191e810c19729de860ea",
    • "is_sub_river_run": false,
    • "is_high_frequency": false,
    • "pricing_category": "string",
    • "trigger_name": "ui",
    • "triggered_by_run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
    • "trigger_chain": [

      • {

        • "trigger_name": "scheduled"

        },
      • {

        • "run_id": "R1",
        • "trigger_name": "logic"

        }

      ]

    }

  ],
• "river_cross_id": "string"

}

Get Data Flow Activities Run

Authorization scope: activity:list

Get a specific run details.

---

📖 Instructions for usage

run_data_flow, get_run

run_data_flow

Trigger an immediate run of a data flow.

By default returns instantly with the run_id (do NOT poll). Set wait=True to block
until the run reaches a terminal state (success/failed/cancelled) and return the
final run object — useful for tests/automation so you don't sleep blindly.

Before calling this, make sure ALL source tables are configured in a single
set_data_flow_source_tables call — one data flow syncs multiple tables in one run.

Common 400 causes:
  - Data flow not yet activated: call activate_data_flow(wait=True) first.
  - No source tables configured: call set_data_flow_source_tables first.

get_run

Get the status and result of a data flow run by its run_id.

Use the run_group_id returned by run_data_flow as the run_id here.
Status is returned as a plain string: pending, running, success, failed.
Check error_description for failure details.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)

Responses

Response Schema: application/json

run_id required	string (Run Id) The run ID
river_cross_id required	string (River Cross Id) The river cross ID
datasource_id required	string (Datasource Id) The datasource ID
required	Error Description (string) or Error Description (null) (Error Description) The error description if any
units required	number (Units) Total RPU (units)
rpu required	number (Rpu) Total RPU
run_group_id required	string (Run Group Id) The run group id
status required	string (ActivityStatusEnum) Enum: "pending" "canceled" "succeeded" "failed" "running" "skipped" The external status of a run (being used in the api)
source_name required	string (Source Name) The name of the source
start_date_utc required	string <date-time> (Start Date Utc) The start date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms
start_date_in_milliseconds required	integer (Start Date In Milliseconds) The start epoch in milliseconds.
required	End Date Utc (string) or End Date Utc (null) (End Date Utc) The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms
required	End Date In Milliseconds (integer) or End Date In Milliseconds (null) (End Date In Milliseconds) The end epoch in milliseconds.
is_sub_river_run required	boolean (Is Sub River Run) A flag that indicates whether this run is of a sub river or not
	Target Name (string) or Target Name (null) (Target Name) The target table name
	Sub River Id (string) or Sub River Id (null) (Sub River Id) The sub river id
	Is High Frequency (boolean) or Is High Frequency (null) (Is High Frequency) Default: false A flag that indicates whether this run is high frequency or not
	Pricing Category (string) or Pricing Category (null) (Pricing Category) The RPU policy rule object for calculating an RPU
	TriggerName (string) or null The mechanism that started the run. Empty for runs of an account that does not track triggers
	Triggered By Run Id (string) or Triggered By Run Id (null) (Triggered By Run Id) The run that triggered this one. Empty when the run is the root of its tree
	Array of TriggerChain (objects) or null The trigger events leading back to the act that started the whole run tree, oldest first

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}

Response samples

• 200
• 422

Content type

application/json

{

• "run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
• "river_cross_id": "507f191e810c19729de860ea",
• "datasource_id": "mysql",
• "error_description": "error",
• "units": 2.1,
• "rpu": 2.1,
• "run_group_id": "201dcf8182ad4a59868cb41b957fdc8d",
• "status": "pending",
• "source_name": "mysql",
• "target_name": "table",
• "start_date_utc": "2022-07-25T18:38:55.640Z",
• "start_date_in_milliseconds": 1658774335000,
• "end_date_utc": "2022-07-25T18:38:55.640Z",
• "end_date_in_milliseconds": 1658774335000,
• "sub_river_id": "507f191e810c19729de860ea",
• "is_sub_river_run": false,
• "is_high_frequency": false,
• "pricing_category": "string",
• "trigger_name": "ui",
• "triggered_by_run_id": "5658a1c9ea724ee59f048cbb5a6f734a",
• "trigger_chain": [

  • {

    • "trigger_name": "scheduled"

    },
  • {

    • "run_id": "R1",
    • "trigger_name": "logic"

    }

  ]

}

Get Run Logs

Authorization scope: activity:list

This method fetches the logs for a given run id of a data flow.

---

📖 Instructions for usage

get_run_logs

Download the logs for a specific data flow run as CSV text.

Returns raw CSV content with all log lines for the run.
Logs are only available for runs within the last 2 weeks.
If the response is empty, the data source may not support logs.

Use get_run first to confirm the run exists, then call this to fetch its logs.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
run_id required	string (Run Id)

query Parameters

Array of Additional Services (strings) or Additional Services (null) (Additional Services) Additional services to query

Responses

Response Schema: text/html

string

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logs

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logs

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}