Get flow views catalog
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=views
Overview
Returns view options (name, value) for view-based flow definitions.
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 views. |
app_id | String | Yes | Target app ID. |
query | String | No | Optional case-insensitive name search. |
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=views&
app_id=64f5c0d8f4f7ac0012ab3456&
query=checkout
Response
Success Response
{
"result": [
{
"value": "67aa9c0a6d1f0b00123a4567",
"name": "Checkout"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
result | Array | View option list. |
result[].value | String | View ID (_id). |
result[].name | String | display if set, otherwise view. |
Error Responses
400
{
"result": "DB error. Please check logs"
}
Behavior
- Reads
countly.app_viewsmetafor app (a = app_id). - Optional regex filter on projected name.
- Sorts by name descending and limits to 100.
- Uses
returnMessage(200, res)for success.
Related Endpoints
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.app_viewsmeta | Endpoint data source | Stores endpoint-related records this endpoint reads or modifies. |