Flows

Get All Flows

Returns all flows accessible to the authenticated user.

get/flows

Request

Query parameters

flows_only1

By default, flows responses include sub-lists of the resources included in the flows, such as data_sources, data_sets and data_sinks. If you do not need resource details and just need flow chain, include the flows_only query parameter in your request. This option can improve request response time significantly.

include_run_metrics1

By default, flows responses do not include run metrics. If you want to include run metrics in the response, include the include_run_metrics query parameter in your request.

pageinteger

Add this parameter to a resource fetch request to fetch a specific page of data.

per_pageinteger

Add this parameter to a resource fetch request to set the number of items that should be returned in each request.

access_role'collaborator' | 'operator' | 'admin' | 'owner'

Add this query parameter to a request to view resources for which the authenticated user has permission.

  1. collaborator: Resources to which the user has access via the collaborator or higher permissions.
  2. operator: Resources to which the user has access via the operator or higher permissions.
  3. admin: Resources to which the user has access via the administrator or owner permissions.
  4. owner: Resources created by the user. Note that the absence of this property in the request is treated as owner, so you do not need to set access_role=owner in the query.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.