Payments Reports

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Discounts

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments Reports

Operations

Get transaction volume time series

Request

Returns time series data for transaction volume (count) over a specified period with configurable intervals

Query
periodstringrequired
start_datestring
end_datestring
intervalstring
filters[integration_class][]Array of strings

Filter by integration classes (transaction providers)

Example: filters[integration_class][]=CreditCard&filters[integration_class][]=PayPal
filters[adapter_class][]Array of strings

Filter by adapter classes (gateways)

Example: filters[adapter_class][]=Stripe&filters[adapter_class][]=AuthorizeNet
filters[status][]Array of strings

Filter by payment status

Example: filters[status][]=success&filters[status][]=declined
filters[currency_code][]Array of strings

Filter by currency codes

Example: filters[currency_code][]=USD&filters[currency_code][]=EUR
filters[payment_action][]Array of strings

Filter by payment actions

Example: filters[payment_action][]=authorize&filters[payment_action][]=capture
filters[type]string

Filter by payment type

Enum"test""live"
Example: filters[type]=live
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/payments/reports/transaction_volume?end_date=string&filters%5Badapter_class%5D%5B%5D=string&filters%5Bcurrency_code%5D%5B%5D=string&filters%5Bintegration_class%5D%5B%5D=string&filters%5Bpayment_action%5D%5B%5D=string&filters%5Bstatus%5D%5B%5D=string&filters%5Btype%5D=test&interval=string&period=string&start_date=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Transaction volume data retrieved successfully

Bodyapplication/json
data_pointsArray of objectsrequired
data_points[].​timestampstring(date-time)required
Example: "2025-01-15T10:00:00Z"
data_points[].​valuenumber or null
Example: 150
data_points[].​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
kpisobjectrequired
kpis.​totalnumberrequired
Example: 3250
kpis.​previous_period_totalnumberrequired
Example: 2800
kpis.​growthobjectrequired
kpis.​growth.​valuenumberrequired
Example: 450
kpis.​growth.​percentnumberrequired
Example: 16.07
kpis.​averagenumberrequired
Example: 135.42
kpis.​minnumberrequired
Example: 50
kpis.​maxnumberrequired
Example: 200
periodobjectrequired
period.​fromstring(date-time)required
Example: "2025-01-15T00:00:00Z"
period.​tostring(date-time)required
Example: "2025-01-15T23:59:59Z"
period.​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
previous_periodobjectrequired
previous_period.​fromstring(date-time)required
Example: "2025-01-14T00:00:00Z"
previous_period.​tostring(date-time)required
Example: "2025-01-14T23:59:59Z"
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstring(date-time)required
Response
application/json
{
  "data_points": [
    { … }
  ],
  "kpis": {
    "total": 3250,
    "previous_period_total": 2800,
    "growth": { … },
    "average": 135.42,
    "min": 50,
    "max": 200
  },
  "period": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T23:59:59Z",
    "interval": "hourly"
  },
  "previous_period": {
    "from": "2025-01-14T00:00:00Z",
    "to": "2025-01-14T23:59:59Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Get average latency time series

Request

Returns time series data for average transaction response time (latency) in milliseconds over a specified period

Query
periodstringrequired
start_datestring
end_datestring
intervalstring
filters[integration_class][]Array of strings

Filter by integration classes (transaction providers)

Example: filters[integration_class][]=CreditCard
filters[adapter_class][]Array of strings

Filter by adapter classes (gateways)

Example: filters[adapter_class][]=Stripe
filters[type]string

Filter by payment type

Enum"test""live"
Example: filters[type]=live
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/payments/reports/average_latency?end_date=string&filters%5Badapter_class%5D%5B%5D=string&filters%5Bintegration_class%5D%5B%5D=string&filters%5Btype%5D=test&interval=string&period=string&start_date=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Average latency data retrieved successfully

Bodyapplication/json
data_pointsArray of objectsrequired
data_points[].​timestampstring(date-time)required
Example: "2025-01-15T10:00:00Z"
data_points[].​valuenumber or null
Example: 150
data_points[].​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
kpisobjectrequired
kpis.​totalnumberrequired
Example: 3250
kpis.​previous_period_totalnumberrequired
Example: 2800
kpis.​growthobjectrequired
kpis.​growth.​valuenumberrequired
Example: 450
kpis.​growth.​percentnumberrequired
Example: 16.07
kpis.​averagenumberrequired
Example: 135.42
kpis.​minnumberrequired
Example: 50
kpis.​maxnumberrequired
Example: 200
periodobjectrequired
period.​fromstring(date-time)required
Example: "2025-01-15T00:00:00Z"
period.​tostring(date-time)required
Example: "2025-01-15T23:59:59Z"
period.​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
previous_periodobjectrequired
previous_period.​fromstring(date-time)required
Example: "2025-01-14T00:00:00Z"
previous_period.​tostring(date-time)required
Example: "2025-01-14T23:59:59Z"
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstring(date-time)required
Response
application/json
{
  "data_points": [
    { … }
  ],
  "kpis": {
    "total": 3250,
    "previous_period_total": 2800,
    "growth": { … },
    "average": 135.42,
    "min": 50,
    "max": 200
  },
  "period": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T23:59:59Z",
    "interval": "hourly"
  },
  "previous_period": {
    "from": "2025-01-14T00:00:00Z",
    "to": "2025-01-14T23:59:59Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Get approval rate time series

Request

Returns time series data for transaction approval rate (success percentage) over a specified period

Query
periodstringrequired
start_datestring
end_datestring
intervalstring
filters[integration_class][]Array of strings

Filter by integration classes (transaction providers)

Example: filters[integration_class][]=CreditCard&filters[integration_class][]=PayPal
filters[type]string

Filter by payment type

Enum"test""live"
Example: filters[type]=live
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/payments/reports/approval_rate?end_date=string&filters%5Bintegration_class%5D%5B%5D=string&filters%5Btype%5D=test&interval=string&period=string&start_date=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Approval rate data retrieved successfully

Bodyapplication/json
data_pointsArray of objectsrequired
data_points[].​timestampstring(date-time)required
Example: "2025-01-15T10:00:00Z"
data_points[].​valuenumber or null
Example: 150
data_points[].​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
data_points[].​breakdownobjectrequired

Breakdown of payments by category. Categories vary by endpoint (e.g., approved/declined for approval_rate, error types for error breakdowns).

Example: {"approved":145,"declined":5}
data_points[].​breakdown.​property name*integeradditional property

Count of payments in this category

kpisobjectrequired
kpis.​totalnumberrequired
Example: 3250
kpis.​previous_period_totalnumberrequired
Example: 2800
kpis.​growthobjectrequired
kpis.​growth.​valuenumberrequired
Example: 450
kpis.​growth.​percentnumberrequired
Example: 16.07
kpis.​averagenumberrequired
Example: 135.42
kpis.​minnumberrequired
Example: 50
kpis.​maxnumberrequired
Example: 200
periodobjectrequired
period.​fromstring(date-time)required
Example: "2025-01-15T00:00:00Z"
period.​tostring(date-time)required
Example: "2025-01-15T23:59:59Z"
period.​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
previous_periodobjectrequired
previous_period.​fromstring(date-time)required
Example: "2025-01-14T00:00:00Z"
previous_period.​tostring(date-time)required
Example: "2025-01-14T23:59:59Z"
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstring(date-time)required
Response
application/json
{
  "data_points": [
    { … }
  ],
  "kpis": {
    "total": 3250,
    "previous_period_total": 2800,
    "growth": { … },
    "average": 135.42,
    "min": 50,
    "max": 200
  },
  "period": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T23:59:59Z",
    "interval": "hourly"
  },
  "previous_period": {
    "from": "2025-01-14T00:00:00Z",
    "to": "2025-01-14T23:59:59Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Get error rate time series

Request

Returns time series data for transaction error rate (failure percentage) over a specified period

Query
periodstringrequired
start_datestring
end_datestring
intervalstring
filters[integration_class][]Array of strings

Filter by integration classes (transaction providers)

Example: filters[integration_class][]=CreditCard
filters[type]string

Filter by payment type

Enum"test""live"
Example: filters[type]=live
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/payments/reports/error_rate?end_date=string&filters%5Bintegration_class%5D%5B%5D=string&filters%5Btype%5D=test&interval=string&period=string&start_date=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Error rate data retrieved successfully

Bodyapplication/json
data_pointsArray of objectsrequired
data_points[].​timestampstring(date-time)required
Example: "2025-01-15T10:00:00Z"
data_points[].​valuenumber or null
Example: 150
data_points[].​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
kpisobjectrequired
kpis.​totalnumberrequired
Example: 3250
kpis.​previous_period_totalnumberrequired
Example: 2800
kpis.​growthobjectrequired
kpis.​growth.​valuenumberrequired
Example: 450
kpis.​growth.​percentnumberrequired
Example: 16.07
kpis.​averagenumberrequired
Example: 135.42
kpis.​minnumberrequired
Example: 50
kpis.​maxnumberrequired
Example: 200
periodobjectrequired
period.​fromstring(date-time)required
Example: "2025-01-15T00:00:00Z"
period.​tostring(date-time)required
Example: "2025-01-15T23:59:59Z"
period.​intervalstringrequired
Enum"hourly""daily""weekly""monthly"
Example: "hourly"
previous_periodobjectrequired
previous_period.​fromstring(date-time)required
Example: "2025-01-14T00:00:00Z"
previous_period.​tostring(date-time)required
Example: "2025-01-14T23:59:59Z"
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstring(date-time)required
Response
application/json
{
  "data_points": [
    { … }
  ],
  "kpis": {
    "total": 3250,
    "previous_period_total": 2800,
    "growth": { … },
    "average": 135.42,
    "min": 50,
    "max": 200
  },
  "period": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T23:59:59Z",
    "interval": "hourly"
  },
  "previous_period": {
    "from": "2025-01-14T00:00:00Z",
    "to": "2025-01-14T23:59:59Z"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Get aggregated KPIs

Request

Returns aggregated KPIs including transaction count, approval rate, average latency, and error rate with growth comparisons

Query
periodstringrequired
start_datestring
end_datestring
filters[integration_class][]Array of strings

Filter by integration classes (transaction providers)

Example: filters[integration_class][]=CreditCard&filters[integration_class][]=PayPal
filters[adapter_class][]Array of strings

Filter by adapter classes (gateways)

Example: filters[adapter_class][]=Stripe
filters[status][]Array of strings

Filter by payment status

Example: filters[status][]=success
filters[currency_code][]Array of strings

Filter by currency codes

Example: filters[currency_code][]=USD
filters[payment_action][]Array of strings

Filter by payment actions

Example: filters[payment_action][]=authorize
filters[type]string

Filter by payment type

Enum"test""live"
Example: filters[type]=live
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/payments/reports/kpis?end_date=string&filters%5Badapter_class%5D%5B%5D=string&filters%5Bcurrency_code%5D%5B%5D=string&filters%5Bintegration_class%5D%5B%5D=string&filters%5Bpayment_action%5D%5B%5D=string&filters%5Bstatus%5D%5B%5D=string&filters%5Btype%5D=test&period=string&start_date=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

KPIs retrieved successfully

Bodyapplication/json
kpisobjectrequired
kpis.​transaction_countobjectrequired
kpis.​transaction_count.​currentnumberrequired
Example: 3250
kpis.​transaction_count.​previousnumberrequired
Example: 2800
kpis.​transaction_count.​growthobjectrequired
kpis.​transaction_count.​growth.​valuenumberrequired
Example: 450
kpis.​transaction_count.​growth.​percentnumberrequired
Example: 16.07
kpis.​approval_rateobjectrequired
kpis.​approval_rate.​currentnumberrequired
Example: 95.5
kpis.​approval_rate.​previousnumberrequired
Example: 94.2
kpis.​approval_rate.​growthobjectrequired
kpis.​approval_rate.​growth.​valuenumberrequired
Example: 450
kpis.​approval_rate.​growth.​percentnumberrequired
Example: 16.07
kpis.​average_latency_msobjectrequired
kpis.​average_latency_ms.​currentnumberrequired
Example: 1250
kpis.​average_latency_ms.​previousnumberrequired
Example: 1320
kpis.​average_latency_ms.​growthobjectrequired
kpis.​average_latency_ms.​growth.​valuenumberrequired
Example: 450
kpis.​average_latency_ms.​growth.​percentnumberrequired
Example: 16.07
kpis.​error_rateobjectrequired
kpis.​error_rate.​currentnumberrequired
Example: 2.1
kpis.​error_rate.​previousnumberrequired
Example: 2.5
kpis.​error_rate.​growthobjectrequired
kpis.​error_rate.​growth.​valuenumberrequired
Example: 450
kpis.​error_rate.​growth.​percentnumberrequired
Example: 16.07
periodobjectrequired
period.​fromstring(date-time)required
Example: "2025-01-01T00:00:00Z"
period.​tostring(date-time)required
Example: "2025-01-31T23:59:59Z"
period.​intervalstring
Enum"hourly""daily""weekly""monthly"
Example: "daily"
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstring(date-time)required
Response
application/json
{
  "kpis": {
    "transaction_count": { … },
    "approval_rate": { … },
    "average_latency_ms": { … },
    "error_rate": { … }
  },
  "period": {
    "from": "2025-01-01T00:00:00Z",
    "to": "2025-01-31T23:59:59Z",
    "interval": "daily"
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Get available payment providers

Request

Returns available integration classes, adapter classes, and payment accounts that are active

Query
filters[company_id]integer

Filter by company ID

Example: filters[company_id]=1
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/v202506/payments/reports/available_providers?filters%5Bcompany_id%5D=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Available providers filtered by company_id

Bodyapplication/json
integration_classesArray of stringsrequired
Example: ["CreditCard","GCashCitcon","PayPal"]
adapter_classesArray of stringsrequired
Example: ["ActiveMerchant::Billing::Bogus"]
payment_accountsArray of objectsrequired
payment_accounts[].​idintegerrequired
Example: 1
payment_accounts[].​namestringrequired
Example: "Main Payment Account"
payment_accounts[].​integration_classstringrequired
Example: "CreditCard"
payment_accounts[].​adapter_classstring or nullrequired
Example: "ActiveMerchant::Billing::Bogus"
payment_accounts[].​activebooleanrequired
Example: true
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstring(date-time)required
Response
application/json
{
  "integration_classes": [
    "CreditCard",
    "GCashCitcon",
    "PayPal"
  ],
  "adapter_classes": [
    "ActiveMerchant::Billing::Bogus"
  ],
  "payment_accounts": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

Get a specific media

Request

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/media/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media retrieved successfully

Bodyapplication/json
idintegerrequired
user_idinteger or null
titlestringrequired
descriptionobject or null
strippedstring or null
media_typestringrequired
Enum"share""update""training""upload"
media_formatstring or null
image_urlstring or null
video_urlstring or null
pdf_urlstring or null
kindstring or null
activebooleanrequired
visibilityinteger or null
share_linkstring or null
preview_linkstring or null
viewsintegerrequired
leadsintegerrequired
watchobject or null
video_statusstring or null
durationinteger or null
cta_urlstring or null
cta_button_textstring or null
cta_enabledbooleanrequired
cta_action_typestring or null
video_shopping_enabledbooleanrequired
prompts_enabledbooleanrequired
ranksArray of strings
settingsobject or null
application_theme_template_idinteger or null
created_atstring(date-time)required
subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects
tagsArray of objects
slugstring or null

URL-friendly slug for the media item

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects
commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string"
}