Docs API Reference Payment Gateway/bff/payment-gateway/monthly-analytics-by-order-group

/bff/payment-gateway/monthly-analytics-by-order-group

Returns rows = months, columns = order groups, cells = the received amount plus the number of orders that eventually got paid via this gateway. Uses the same order-level semantics as /monthly-analytics (storno excluded, one order = one row, bucketed by first-attempt month). Column set is limited to groups that actually appear in the window — empty groups are dropped to keep the table readable.

Payment GatewaygetBffPayment-gatewayMonthly-analytics-by-order-group

Parameters

2 query

Query parameters

· 2

codestringRequired

Gateway instance code/slug.

Examplecomgate-smichov

monthCountstringOptional

How many calendar months to return (default 24, clamped to [1, 240]). Same clamp semantics as /monthly-analytics.

Example12

Response schema

1 status code documented

200SuccessPer-(month × order group) received-amount pivot for a single payment-gateway instance.

gatewayCodestringRequired

gatewayNamestringRequired

currencystringRequired

monthCountnumberRequired

Effective number of months in the pivot (may be shorter than requested when the gateway has less history).

groupsobject[]Required

Each array item:

idstringRequired

shop__order_group.id echoed as string.

codestringRequired

namestringRequired

monthsobject[]Required

Each array item:

monthstringRequired

YYYY-MM bucket.

cellsobject[]Required

Each array item:

groupIdstringRequired

receivedAmountnumberRequired

paidOrderCountnumberRequired

totalnumberRequired

Sum of receivedAmount across all groups in this month.

totalPaidOrderCountnumberRequired

Sum of paidOrderCount across all groups in this month.

totalsByGroupobject[]Required

Each array item:

groupIdstringRequired

receivedAmountnumberRequired

paidOrderCountnumberRequired

grandTotalnumberRequired

grandPaidOrderCountnumberRequired

Response example

application/json

{
  "gatewayCode": "example_gatewayCode",
  "gatewayName": "example_gatewayName",
  "currency": "example_currency",
  "monthCount": 0,
  "groups": [
    {
      "id": "example_id",
      "code": "example_code",
      "name": "example_name"
    }
  ],
  "months": [
    {
      "month": "example_month",
      "cells": [
        {
          "groupId": "example_groupId",
          "receivedAmount": 0,
          "paidOrderCount": 0
        }
      ],
      "total": 0,
      "totalPaidOrderCount": 0
    }
  ],
  "totalsByGroup": [
    {
      "groupId": "example_groupId",
      "receivedAmount": 0,
      "paidOrderCount": 0
    }
  ],
  "grandTotal": 0,
  "grandPaidOrderCount": 0
}

Request example

GET /bff/payment-gateway/monthly-analytics-by-order-group

get

curl -X GET "https://api.bizkithub.com/bff/payment-gateway/monthly-analytics-by-order-group?code=comgate-smichov&monthCount=12" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key