Get Flow analytics data

Returns aggregated analytics data for the Flow product in the specified environment.

GET /environments/{environmentId}/flow/analytics

Get Flow analytics data

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.dynamicauth.com/api/v0/environments/{environmentId}/flow/analytics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "avgAmountUsd": 123,
  "avgCompletionTimeMs": 123,
  "completedFlows": 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
    }
  ],
  "failedFlows": 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>"
    }
  ],
  "settledFlows": 123,
  "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>"
    }
  ],
  "stepBreakdown": [
    {
      "cancelled": 123,
      "completed": 123,
      "expired": 123,
      "failed": 123,
      "inProgress": 123,
      "reached": 123,
      "stage": "<string>",
      "total": 123
    }
  ],
  "totalFlows": 123,
  "volumeByCurrency": [
    {
      "count": 123,
      "currency": "<string>",
      "volume": 123
    }
  ],
  "volumeByDirection": [
    {
      "count": 123,
      "direction": "<string>",
      "volume": 123
    }
  ],
  "volumeByMode": [
    {
      "count": 123,
      "mode": "<string>",
      "volume": 123
    }
  ],
  "waitingForSettlementFlows": 123
}

{
  "error": "<string>"
}

{
  "error": "No jwt provided!"
}

{
  "error": "Access Forbidden"
}

{
  "error": "Internal Server Error"
}

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

200

application/json

Flow analytics summary

avgAmountUsd · number · required

Average transaction amount in USD

avgCompletionTimeMs · number · required

Average time from flow creation to completion in milliseconds

completedFlows · integer · required

Number of flows that reached settlement completed

completedVolume · number · required

Total completed transaction volume

cumulativeVolume · object[] · required

Cumulative volume over time (running total)

Show child attributes

dailyVolume · object[] · required

Daily volume and count breakdown

Show child attributes

destChains · object[] · required

Destination chains ranked by flow count

Show child attributes

destTokens · object[] · required

Destination tokens ranked by flow count

Show child attributes

failureCategories · object[] · required

Failure count grouped by failure category

Show child attributes

failedFlows · integer · required

Number of flows with execution or settlement failed

failureRate · number · required

Ratio of failed flows to terminal (completed + failed) 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)

Show child attributes

recentErrors · object[] · required

Most recent flow errors with details for drill-down

Show child attributes

settledFlows · integer · required

Number of source-confirmed flows that reached settlement completed

settlementStateBreakdown · object[] · required

Flow count grouped by settlement state

Show child attributes

sourceChains · object[] · required

Source chains ranked by flow count

Show child attributes

sourceTokens · object[] · required

Source tokens ranked by flow count

Show child attributes

sourceTypeBreakdown · object[] · required

Flow count grouped by source type

Show child attributes

stateBreakdown · object[] · required

Flow count grouped by execution state

Show child attributes

stepBreakdown · object[] · required

Flow count per lifecycle stage showing reached, in-progress, completed, and drop-off reasons

Show child attributes

totalFlows · integer · required

Total number of flows in the period

volumeByCurrency · object[] · required

Completed volume and count grouped by pricing currency

Show child attributes

volumeByDirection · object[] · required

Completed volume and count grouped by pay-in/pay-out direction

Show child attributes

volumeByMode · object[] · required

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

Show child attributes

waitingForSettlementFlows · integer · required

Number of source-confirmed flows still waiting for settlement