Retrieves aggregated sales metrics for a specified date range. Returns hourly or daily granularity with order counts and sales totals grouped by currency.

API ownership

• API family: Management API
• Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
• Do not use from: Browser-only storefront code or public clients.
• Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

• Method: GET
• Path: /api/v1/\{team_slug\}/\{app_slug\}/orders/metrics
• Summary: Get sales metrics
• Description: Retrieves aggregated sales metrics for a specified date range. Returns hourly or daily granularity with order counts and sales totals grouped by currency.
• OpenAPI contract: management-api
• Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

{
  "data": {
    "daily_metrics": [
      {
        "day": "string",
        "order_count": 0,
        "sales_by_currency": []
      }
    ],
    "hourly_metrics": [
      {
        "hour": "string",
        "order_count": 0,
        "sales_by_currency": []
      }
    ],
    "total_order_count": 0,
    "total_sales_by_currency": [
      {
        "currency_code": "string",
        "total_compensated_sales": 0,
        "total_sales_amount": 0
      }
    ]
  },
  "details": [
    "string"
  ],
  "success": false
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

• API family: Management API
• Method: GET
• Path: /api/v1/\{team_slug\}/\{app_slug\}/orders/metrics
• Operation ID: Not documented in the OpenAPI contract.
• OpenAPI tag: Orders
• OpenAPI summary: Get sales metrics