Get flow data

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/o/flows?method=data

Overview

Returns calculated flow data document for a flow.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

Requires flows Read permission.

Request Parameters

Parameter	Type	Required	Description
method	String	Yes	Must be data.
app_id	String	Yes	Target app ID.
_id	String	Yes	Flow ID. Must start with <app_id>_.
api_key	String	Conditional	Required if auth_token is not provided.
auth_token	String	Conditional	Required if api_key is not provided.

Examples

/o/flows?
  method=data&
  app_id=64f5c0d8f4f7ac0012ab3456&
  _id=64f5c0d8f4f7ac0012ab3456_67bd31c92e7f0b0012ab4567

Response

Success Response

{
  "_id": "64f5c0d8f4f7ac0012ab3456_67bd31c92e7f0b0012ab4567_data"
}

Response Fields

Field	Type	Description
(root object)	Object	First matching flow data document, or empty object.

Error Responses

• 400

{
  "result": "Flow not found"
}

Behavior

• Validates _id prefix against app_id.
• Reads countly.flow_data by _id regex (^<flow_id>.*).
• Returns first matched document or {}.

Related Endpoints

• Flows - Calculate
• Flows - Info

Implementation details

Configuration Impact

Setting	Default	Affects	User-visible impact
flows.*	Flows feature defaults	Flows analytics query behavior and result shaping.	Changes to flows settings can affect returned paths, aggregation behavior, and limits.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.flow_data	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.