Skip to main content
GET
/
v1
/
analytics
/
flow
/
behavior
Get user flow behavior
curl --request GET \
  --url https://api.oneofnone.io/v1/analytics/flow/behavior \
  --header 'x-api-key: <api-key>'
{
  "meta": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "data": [
    {
      "from_step": "<string>",
      "to_step": "<string>",
      "sessions": 1,
      "users": 1
    }
  ],
  "rows": 123,
  "statistics": {
    "elapsed": 123,
    "rows_read": 123,
    "bytes_read": 123
  }
}

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Query Parameters

​
collection_id
string<uuid>

Filter by collection ID.

​
collection_slug
string

Filter by collection slug.

​
date_from
string<date>
required

Start date in ISO 8601 format (required).

​
date_to
string<date>

End date in ISO 8601 format.

​
dimension
enum<string>

The dimension to analyze flow by.

Available options:
action,
pathname
​
limit
integer

Number of results per page.

Required range: 1 <= x <= 1000
​
offset
integer

Offset for pagination.

Required range: x >= 0

Response

Successfully retrieved flow behavior data.

Tinybird response envelope for flow/behavior.

​
meta
object[]
required
​
data
object[]
required
​
rows
integer
required
​
statistics
object
required

Query execution statistics returned in every Tinybird API response.