Metrics

Hotmart metrics via API

Your customer connects their Hotmart account and your product queries 33 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": "ht:final_revenue_usd",
      "component": "number_v1",
      "metrics": [
        "final_revenue_usd"
      ]
    }
  ]
}
Example: "Net Revenue ($)" in October, compared to September.

More Hotmart 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

Percentage of sales by product

This chart shows the percentage of sales grouped by the products in your account.

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": "ht:purchases_by_product",
      "component": "chart_v1",
      "metrics": [
        "sales_count"
      ],
      "dimensions": [
        "product"
      ]
    }
  ]
}

Table

Sales by Product

Product performance summary during the analyzed 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": "ht:revenue_by_product",
      "component": "datatable_v1",
      "metrics": [
        "sales_count",
        "sales_rate",
        "revenue_brl",
        "revenue_brl_rate",
        "revenue_usd",
        "revenue_usd_rate",
        "revenue_eur",
        "revenue_eur_rate"
      ],
      "dimensions": [
        "product.name"
      ]
    }
  ]
}

Number

Net Revenue (R$)

Total value of sales revenue, excluding canceled purchases, chargebacks and refunds. This amount is calculated by reducing the amounts of canceled purchases, chargebacks and refunds from the total revenue.

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": "ht:final_revenue_brl",
      "component": "number_v1",
      "metrics": [
        "final_revenue_brl"
      ]
    }
  ]
}

Numbers

24 metrics

  • Net Revenue ($)

    Total value of sales revenue, excluding canceled purchases, chargebacks and refunds. This amount is calculated by reducing the amounts of canceled purchases, chargebacks and refunds from the total revenue.

    ht:final_revenue_usd
  • Net Revenue (R$)

    Total value of sales revenue, excluding canceled purchases, chargebacks and refunds. This amount is calculated by reducing the amounts of canceled purchases, chargebacks and refunds from the total revenue.

    ht:final_revenue_brl
  • Net Revenue (€)

    Total value of sales revenue, excluding canceled purchases, chargebacks and refunds. This amount is calculated by reducing the amounts of canceled purchases, chargebacks and refunds from the total revenue.

    ht:final_revenue_eur
  • Total Revenue ($)

    Total amount of sales revenue, including canceled purchases, chargebacks, and refunds.

    ht:revenue_usd
  • Total Revenue (R$)

    Total amount of sales revenue, including canceled purchases, chargebacks, and refunds.

    ht:revenue_brl
  • Total Revenue (€)

    Total amount of sales revenue, including canceled purchases, chargebacks, and refunds.

    ht:revenue_eur
  • Chargebacks amount ($)

    Total amount of chargebacks performed during the analyzed period. Chargeback is when the customer requests a refund of the purchase directly from their credit card company.

    ht:chargeback_usd
  • Chargebacks amount (R$)

    Total amount of chargebacks performed during the analyzed period. Chargeback is when the customer requests a refund of the purchase directly from their credit card company.

    ht:chargeback_brl
  • Chargebacks amount (€)

    Total amount of chargebacks performed during the analyzed period. Chargeback is when the customer requests a refund of the purchase directly from their credit card company.

    ht:chargeback_eur
  • Total value of canceled purchases ($)

    Total value of purchases that were canceled due to a problem or impediment.

    ht:canceled_usd
  • Total value of canceled purchases (R$)

    Total value of purchases that were canceled due to a problem or impediment.

    ht:canceled_brl
  • Total value of canceled purchases (€)

    Total value of purchases that were canceled due to a problem or impediment.

    ht:canceled_eur
  • Total amount of refunds ($)

    Total amount of sales that were refunded or chargebacked.

    ht:refunded_chargeback_usd
  • Total amount of refunds (R$)

    Total amount of sales that were refunded or chargebacked.

    ht:refunded_chargeback_brl
  • Total amount of refunds (€)

    Total amount of sales that were refunded or chargebacked.

    ht:refunded_chargeback_eur
  • Refunds ($)

    Total amount of refunds ($)

    ht:refunded_usd
  • Refunds (R$)

    Total amount of refunds (R$)

    ht:refunded_brl
  • Refunds (€)

    Total amount of refunds (€)

    ht:refunded_eur
  • Sales

    Total number of sales made disregarding the number of canceled sales.

    ht:complete_count
  • Canceled sales

    Total number of sales that were canceled due to a problem or impediment.

    ht:canceled_sales_count
  • Chargebacks

    Total number of chargebacks requested during the period analyzed. Chargeback is when the customer requests a refund of the purchase directly from their credit card company.

    ht:chargeback_count
  • Total sales

    Total number of sales with approved or complete status during the analyzed period.

    ht:final_sales_amount
  • Number of Refunds

    Number of purchases refunded

    ht:refunded_sales_count
  • Total Number of Refunds

    Number of purchases refunded + chargebacks

    ht:total_refunded_sales_count

Charts

8 metrics

  • Percentage of sales by product

    This chart shows the percentage of sales grouped by the products in your account.

    ht:purchases_by_product
  • Sales Over Time

    This chart shows the evolution of your sales over the period analyzed.

    ht:purchases_over_time
  • Revenue over time ($)

    This graph shows the evolution of revenue during the selected analysis period. Approved and complete sales are taken into account, without disregarding the value of chargebacks and refunds.

    ht:revenue_over_time_usd
  • Revenue over time (R$)

    This graph shows the evolution of revenue during the selected analysis period. Approved and complete sales are taken into account, without disregarding the value of chargebacks and refunds.

    ht:revenue_over_time_brl
  • Revenue over time (€)

    This graph shows the evolution of revenue during the selected analysis period. Approved and complete sales are taken into account, without disregarding the value of chargebacks and refunds.

    ht:revenue_over_time_eur
  • Net revenue over time ($)

    This chart shows the evolution of net revenue during the selected analysis period. Only approved and complete sales are considered; canceled purchases, chargebacks and refunds are excluded.

    ht:final_revenue_over_time_usd
  • Net revenue over time (R$)

    This chart shows the evolution of net revenue during the selected analysis period. Only approved and complete sales are considered; canceled purchases, chargebacks and refunds are excluded.

    ht:final_revenue_over_time_brl
  • Net revenue over time (€)

    This chart shows the evolution of net revenue during the selected analysis period. Only approved and complete sales are considered; canceled purchases, chargebacks and refunds are excluded.

    ht:final_revenue_over_time_eur

Tables

1 metric

  • Sales by Product

    Product performance summary during the analyzed period.

    ht:revenue_by_product

See Connect applied to your product.

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