Skip to main content
GET
/
environments
/
{environmentId}
/
flow
/
analytics
Get Flow analytics data
curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics \
  --header 'Authorization: Bearer <token>'
{
  "avgAmountUsd": 123,
  "avgCompletionTimeMs": 123,
  "completedVolume": 123,
  "cumulativeVolume": [
    {
      "cumulativeCount": 123,
      "cumulativeVolume": 123,
      "date": "<string>"
    }
  ],
  "dailyVolume": [
    {
      "count": 123,
      "date": "<string>",
      "volume": 123
    }
  ],
  "destChains": [
    {
      "count": 123,
      "name": "<string>"
    }
  ],
  "destTokens": [
    {
      "count": 123,
      "token": "<string>"
    }
  ],
  "failureCategories": [
    {
      "category": "<string>",
      "count": 123
    }
  ],
  "failureRate": 123,
  "modeBreakdown": [
    {
      "count": 123,
      "mode": "<string>"
    }
  ],
  "recentErrors": [
    {
      "category": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "executionState": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "fromChain": "<string>",
      "message": "<string>",
      "toChain": "<string>"
    }
  ],
  "settlementStateBreakdown": [
    {
      "count": 123,
      "state": "<string>"
    }
  ],
  "sourceChains": [
    {
      "count": 123,
      "name": "<string>"
    }
  ],
  "sourceTokens": [
    {
      "count": 123,
      "token": "<string>"
    }
  ],
  "sourceTypeBreakdown": [
    {
      "count": 123,
      "sourceType": "<string>"
    }
  ],
  "stateBreakdown": [
    {
      "count": 123,
      "state": "<string>"
    }
  ],
  "totalFlows": 123,
  "volumeByMode": [
    {
      "count": 123,
      "mode": "<string>",
      "volume": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Query Parameters

start
string<date-time>
required

ISO 8601 date-time for the start of the analytics window

end
string<date-time>
required

ISO 8601 date-time for the end of the analytics window

Response

Flow analytics summary

avgAmountUsd
number
required

Average transaction amount in USD

avgCompletionTimeMs
number
required

Average time from flow creation to completion in milliseconds

completedVolume
number
required

Total completed transaction volume

cumulativeVolume
object[]
required

Cumulative volume over time (running total)

dailyVolume
object[]
required

Daily volume and count breakdown

destChains
object[]
required

Destination chains ranked by flow count

destTokens
object[]
required

Destination tokens ranked by flow count

failureCategories
object[]
required

Failure count grouped by failure category

failureRate
number
required

Ratio of failed/expired/cancelled flows to total flows

healthStatus
enum<string>
required

Overall health status based on success rate and error trends

Available options:
green,
yellow,
red
modeBreakdown
object[]
required

Flow count grouped by mode (payment, deposit, withdraw)

recentErrors
object[]
required

Most recent flow errors with details for drill-down

settlementStateBreakdown
object[]
required

Flow count grouped by settlement state

sourceChains
object[]
required

Source chains ranked by flow count

sourceTokens
object[]
required

Source tokens ranked by flow count

sourceTypeBreakdown
object[]
required

Flow count grouped by source type

stateBreakdown
object[]
required

Flow count grouped by execution state

totalFlows
integer
required

Total number of flows in the period

volumeByMode
object[]
required

Volume and count grouped by mode (payment, deposit, withdraw)

Last modified on June 30, 2026