Get EndUser recurring transactions report
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report"
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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report', 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.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report",
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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report"
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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report")
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[
{
"avg_amount": {
"amount": "1234.56",
"currency": "USD"
},
"avg_confidence": 123,
"counterparty": "<string>",
"merchant_group_id": "<string>",
"merchant_heron_id": "<string>",
"merchant_name": "<string>",
"transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"category_confidence": 123,
"category_heron_id": "<string>",
"category_label": "<string>",
"counterparty": "<string>",
"description": "<string>",
"merchant_group_id": "<string>",
"merchant_heron_id": "<string>",
"merchant_name": "<string>"
}
]
}
]EndUserCalculations
Get EndUser recurring transactions report
Get a report of recurring transactions grouped by merchant or counterparty for an end user
GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
recurring_transactions_report
Get EndUser recurring transactions report
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report"
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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report', 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.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report",
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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report"
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://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report")
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[
{
"avg_amount": {
"amount": "1234.56",
"currency": "USD"
},
"avg_confidence": 123,
"counterparty": "<string>",
"merchant_group_id": "<string>",
"merchant_heron_id": "<string>",
"merchant_name": "<string>",
"transactions": [
{
"amount": {
"amount": "1234.56",
"currency": "USD"
},
"heron_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"category_confidence": 123,
"category_heron_id": "<string>",
"category_label": "<string>",
"counterparty": "<string>",
"description": "<string>",
"merchant_group_id": "<string>",
"merchant_heron_id": "<string>",
"merchant_name": "<string>"
}
]
}
]Authorizations
Path Parameters
Query Parameters
Account ids to include in the report, if not provided, all accounts are included
Response
200 - application/json
OK
Show child attributes
Show child attributes
Available options:
not_enough_data, same_day, irregular, daily, weekly, biweekly, monthly, quarterly, annually, weekday, twice_weekly Show child attributes
Show child attributes
Was this page helpful?
⌘I