Metrics

Eduzz metrics via API

Your customer connects their Eduzz account and your product queries 16 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "edz:total_sales",
      "component": "number_v1",
      "metrics": [
        "sales"
      ]
    }
  ]
}
Example: "Total sales" in October, compared to September.

More Eduzz request examples

The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).

Chart

Sales over time

Completed sales over time in the selected period.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "edz:sales_over_time",
      "component": "chart_v1",
      "metrics": [
        "sales"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Table

Products

List of products with status, price and sales in the selected period.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "edz:products_table",
      "component": "datatable_v1",
      "metrics": [
        "status",
        "price",
        "sales"
      ],
      "dimensions": [
        "products"
      ]
    }
  ]
}

Number

Gross revenue

Total gross revenue from paid sales in the selected period.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "edz:revenue_total",
      "component": "number_v1",
      "metrics": [
        "revenue_total"
      ]
    }
  ]
}

Numbers

8 metrics

  • Total sales

    Total number of completed sales in the selected period.

    edz:total_sales
  • Gross revenue

    Total gross revenue from paid sales in the selected period.

    edz:revenue_total
  • Net revenue

    Total net revenue from paid sales in the selected period.

    edz:revenue_net
  • Refunds

    Total number of refunds in the selected period.

    edz:refunds_total
  • Paid invoices

    Total number of paid invoices in the selected period.

    edz:invoices_paid
  • Refunded invoices

    Total number of refunded invoices in the selected period.

    edz:invoices_refunded
  • Canceled invoices

    Total number of canceled invoices in the selected period.

    edz:invoices_canceled
  • Refund rate

    Refunds divided by total sales.

    edz:refund_rate

Charts

5 metrics

  • Sales over time

    Completed sales over time in the selected period.

    edz:sales_over_time
  • Sales by payment method over time

    Completed sales over time split by payment method.

    edz:sales_by_payment_over_time
  • Payment types in completed sales

    Distribution of completed sales by payment method.

    edz:payment_types_bar
  • Sales origin

    Distribution of completed sales by origin (product vs affiliate).

    edz:sales_origin_pie
  • Top product type

    Distribution of sales by product type.

    edz:top_product_type_pie

Tables

3 metrics

  • Products

    List of products with status, price and sales in the selected period.

    edz:products_table
  • Affiliates

    Affiliates linked to products with commission data.

    edz:affiliates_table
  • Affiliate commissions paid

    Paid commissions grouped by affiliate.

    edz:affiliate_commissions_paid

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.