Get sales metrics - Enad

GET

api

{team_slug}

{app_slug}

orders

metrics

Error

A valid request URL is required to generate request examples

{
  "data": {
    "daily_metrics": [
      {
        "day": "<string>",
        "order_count": 123,
        "sales_by_currency": [
          {
            "currency_code": "<string>",
            "total_compensated_sales": 123,
            "total_sales_amount": 123
          }
        ]
      }
    ],
    "hourly_metrics": [
      {
        "hour": "<string>",
        "order_count": 123,
        "sales_by_currency": [
          {
            "currency_code": "<string>",
            "total_compensated_sales": 123,
            "total_sales_amount": 123
          }
        ]
      }
    ],
    "total_order_count": 123,
    "total_sales_by_currency": [
      {
        "currency_code": "<string>",
        "total_compensated_sales": 123,
        "total_sales_amount": 123
      }
    ]
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

app_slug

string

required

App slug

team_slug

string

required

Team slug

Query Parameters

start_date

string

required

Start date (YYYY-MM-DD)

end_date

string

required

End date (YYYY-MM-DD)

granularity

string

Granularity of the metrics (hour, day)

Response

Sales metrics with order counts retrieved successfully

data

object

Show child attributes

details

string[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

success

boolean

List all organizationsRetrieves a paginated list of organizations with comprehensive filtering options including search, status, country, credit check status, custom attributes, and date ranges. Supports sorting and pagination.

Error

A valid request URL is required to generate request examples

{
  "data": {
    "daily_metrics": [
      {
        "day": "<string>",
        "order_count": 123,
        "sales_by_currency": [
          {
            "currency_code": "<string>",
            "total_compensated_sales": 123,
            "total_sales_amount": 123
          }
        ]
      }
    ],
    "hourly_metrics": [
      {
        "hour": "<string>",
        "order_count": 123,
        "sales_by_currency": [
          {
            "currency_code": "<string>",
            "total_compensated_sales": 123,
            "total_sales_amount": 123
          }
        ]
      }
    ],
    "total_order_count": 123,
    "total_sales_by_currency": [
      {
        "currency_code": "<string>",
        "total_compensated_sales": 123,
        "total_sales_amount": 123
      }
    ]
  },
  "details": [
    "<string>"
  ],
  "success": true
}