Hermos API

Get Merchant Overview

Recorded revenue.v2 cash totals, corrected to the signed Home position. Net deducts refunds, chargebacks and net tax, but not untracked affiliate commissions. Product rows contain aggregate identities only. Buckets use Home calendar granularity with equal-length previous periods. Mixed-currency totals, incomplete sources and zero-denominator percentages are not_ready. Other unavailable metrics retain explicit reasons; overview readiness is partial.

GET/reports/overview

Recorded revenue.v2 cash totals, corrected to the signed Home position. Net deducts refunds, chargebacks and net tax, but not untracked affiliate commissions. Product rows contain aggregate identities only. Buckets use Home calendar granularity with equal-length previous periods. Mixed-currency totals, incomplete sources and zero-denominator percentages are not_ready. Other unavailable metrics retain explicit reasons; overview readiness is partial.

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

timeframe?string

Value in

  • "today"
  • "7d"
  • "30d"
  • "90d"
  • "12m"
product?string

Product public ID, or all (default). Supported on revenue.v2 tokens.

plans[]?|array<string>

Plan public IDs; a single value is accepted. Deduplicated, maximum 50 distinct IDs. Combined with product when supplied. Supported on revenue.v2 tokens.

as_of?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reports/overview"
{  "data": {    "object": "report",    "name": "overview",    "livemode": true,    "as_of": "string",    "as_of_time": "2019-08-24T14:15:22Z",    "source": "primary",    "timeframe": "today",    "product": "string",    "plans": [      "string"    ],    "period": {      "starts_at": "2019-08-24",      "ends_at": "2019-08-24"    },    "previous_period": {      "starts_at": "2019-08-24",      "ends_at": "2019-08-24"    },    "buckets": [      {        "starts_at": "2019-08-24T14:15:22Z"      }    ],    "products": [      {        "product_id": "string"      }    ],    "readiness": {      "overview": "available",      "revenue": "available",      "subscriptions": "available",      "customers": "available",      "payments": "available",      "affiliates": "available"    },    "metrics": {      "property1": {        "value": 0,        "reason": null      },      "property2": {        "value": 0,        "reason": null      }    }  },  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}