Transactions

Transaction Amount transaction amount

Returns the total amount collected by the current company’s successful capture, purchase and settle payments, as a time series in base currency units, with KPIs comparing the period against the preceding period. Always scoped to the caller’s company. Optional filters[integration_class][], filters[adapter_class][], filters[status][], filters[currency_code][] and filters[payment_action][] narrow the payments counted, and filters[type] (test or live) separates test from live traffic. A custom period without a valid start_date / end_date pair returns 400. Requires a company admin Bearer token with the reports.view permission.

GET

api

v202506

payments

company_reports

transaction_amount

Transaction Amount transaction amount

curl --request GET \
  --url https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount"

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

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

print(response.text)

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

fetch('https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount', 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.fluid.app/api/v202506/payments/company_reports/transaction_amount",
  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://api.fluid.app/api/v202506/payments/company_reports/transaction_amount"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount")

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

{
  "data_points": [
    {
      "timestamp": "2026-09-23T00:00:00Z",
      "value": 2254.59,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-24T00:00:00Z",
      "value": 2089.62,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-25T00:00:00Z",
      "value": 2474.55,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-26T00:00:00Z",
      "value": 2859.48,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-27T00:00:00Z",
      "value": 2584.53,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-28T00:00:00Z",
      "value": 1979.64,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-29T00:00:00Z",
      "value": 2419.56,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-30T00:00:00Z",
      "value": 1044.81,
      "interval": "daily"
    }
  ],
  "kpis": {
    "total": 17706.78,
    "previous_period_total": 16213.4,
    "growth": {
      "value": 1493.38,
      "percent": 9.21
    },
    "average": 2213.35,
    "min": 1044.81,
    "max": 2859.48
  },
  "period": {
    "from": "2026-09-23T00:00:00Z",
    "to": "2026-09-30T23:59:59Z",
    "interval": "daily"
  },
  "previous_period": {
    "from": "2026-09-15T00:00:00Z",
    "to": "2026-09-23T00:00:00Z"
  },
  "meta": {
    "request_id": "c0a8012e-7f3b-4d6a-9e21-5b8d4f2a6c17",
    "timestamp": "2026-09-30T14:15:22Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 123,
      "prev_cursor": "<string>",
      "next_cursor": "<string>",
      "total_count": 123
    }
  }
}

{
  "message": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 123,
      "prev_cursor": "<string>",
      "next_cursor": "<string>",
      "total_count": 123
    }
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 123,
      "prev_cursor": "<string>",
      "next_cursor": "<string>",
      "total_count": 123
    }
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

period

enum<string>

required

Reporting period for the time series. Use custom together with start_date and end_date.

Available options:

last_24_hours,

last_7_days,

last_30_days,

last_month,

last_year,

custom

start_date

string<date-time>

ISO 8601 start of a custom period. Required when period is custom; must be before end_date.

end_date

string<date-time>

ISO 8601 end of a custom period. Required when period is custom.

interval

enum<string>

Time-series bucket size. Allowed values depend on period; defaults per period when omitted.

Available options:

hourly,

daily,

weekly,

monthly

Response

Success

data_points

object[]

Show child attributes

kpis

object

Show child attributes

period

object

Show child attributes

previous_period

object

Show child attributes

meta

object

Show child attributes

Transaction Amount transaction amount

curl --request GET \
  --url https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount"

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

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

print(response.text)

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

fetch('https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount', 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.fluid.app/api/v202506/payments/company_reports/transaction_amount",
  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://api.fluid.app/api/v202506/payments/company_reports/transaction_amount"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202506/payments/company_reports/transaction_amount")

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

{
  "data_points": [
    {
      "timestamp": "2026-09-23T00:00:00Z",
      "value": 2254.59,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-24T00:00:00Z",
      "value": 2089.62,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-25T00:00:00Z",
      "value": 2474.55,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-26T00:00:00Z",
      "value": 2859.48,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-27T00:00:00Z",
      "value": 2584.53,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-28T00:00:00Z",
      "value": 1979.64,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-29T00:00:00Z",
      "value": 2419.56,
      "interval": "daily"
    },
    {
      "timestamp": "2026-09-30T00:00:00Z",
      "value": 1044.81,
      "interval": "daily"
    }
  ],
  "kpis": {
    "total": 17706.78,
    "previous_period_total": 16213.4,
    "growth": {
      "value": 1493.38,
      "percent": 9.21
    },
    "average": 2213.35,
    "min": 1044.81,
    "max": 2859.48
  },
  "period": {
    "from": "2026-09-23T00:00:00Z",
    "to": "2026-09-30T23:59:59Z",
    "interval": "daily"
  },
  "previous_period": {
    "from": "2026-09-15T00:00:00Z",
    "to": "2026-09-23T00:00:00Z"
  },
  "meta": {
    "request_id": "c0a8012e-7f3b-4d6a-9e21-5b8d4f2a6c17",
    "timestamp": "2026-09-30T14:15:22Z"
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 123,
      "prev_cursor": "<string>",
      "next_cursor": "<string>",
      "total_count": 123
    }
  }
}

{
  "message": "<string>",
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 123,
      "prev_cursor": "<string>",
      "next_cursor": "<string>",
      "total_count": 123
    }
  }
}

{
  "error_message": "<string>",
  "errors": "<string>",
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "pagination": {
      "cursor": "<string>",
      "limit": 123,
      "prev_cursor": "<string>",
      "next_cursor": "<string>",
      "total_count": 123
    }
  }
}

Overview

Storefront

Commerce

Checkout

Members

Messaging

People

Payments

DAM

Website

Portal

Content and tools

Analytics

Sales channels

Settings

FairShare SDK

Droplets

Developers

Portal & Widgets

Transaction Amount transaction amount

Authorizations

Query Parameters

Response