Get usage analytics
curl --request GET \
--url https://api.getdialed.ai/v1/flows/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getdialed.ai/v1/flows/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getdialed.ai/v1/flows/usage', 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://api.getdialed.ai/v1/flows/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://api.getdialed.ai/v1/flows/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getdialed.ai/v1/flows/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/flows/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"series": [
{
"bucket": "2026-07-09T00:00:00Z",
"failed": 2,
"succeeded": 40,
"total": 42
}
],
"top_definitions": [
{
"definition_id": "def_a1b2c3d4",
"succeeded": 124,
"total": 128
}
]
}{
"detail": "Requested range exceeds the maximum span for granularity 'hour' (7 days)"
}{
"detail": "Authentication required"
}{
"detail": "Validation error"
}{
"detail": "Rate limit exceeded: 100 per 1 minute"
}Dashboard & Usage
Get usage analytics
Return a time-bucketed run series plus a per-definition top-N volume table for the caller’s account over [from, to). Bucket size is set by granularity (hour|day|week); bucket timestamps are UTC. The range is clamped server-side per granularity — an out-of-range or inverted span returns 400 before any aggregation runs. Success rates are derivable client-side from the per-bucket and per-definition counts.
GET
/
flows
/
usage
Get usage analytics
curl --request GET \
--url https://api.getdialed.ai/v1/flows/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.getdialed.ai/v1/flows/usage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.getdialed.ai/v1/flows/usage', 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://api.getdialed.ai/v1/flows/usage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://api.getdialed.ai/v1/flows/usage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getdialed.ai/v1/flows/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdialed.ai/v1/flows/usage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"series": [
{
"bucket": "2026-07-09T00:00:00Z",
"failed": 2,
"succeeded": 40,
"total": 42
}
],
"top_definitions": [
{
"definition_id": "def_a1b2c3d4",
"succeeded": 124,
"total": 128
}
]
}{
"detail": "Requested range exceeds the maximum span for granularity 'hour' (7 days)"
}{
"detail": "Authentication required"
}{
"detail": "Validation error"
}{
"detail": "Rate limit exceeded: 100 per 1 minute"
}Authorizations
APIKeyHeaderHTTPBearer
Query Parameters
Range start (inclusive).
Range end (exclusive).
Time-bucket size.
Available options:
hour, day, week Response
Successful Response
The usage/analytics payload: time series + per-definition top-N table.