Skip to content
digizeDocs

Order stats

GET
/api/v1/commerce/orders/stats
curl --request GET \
  --url https://digize.com/api/v1/commerce/orders/stats \
  --header 'x-api-key: <x-api-key>'

Orders, revenue, average order and refund rate for the last 30 days against the 30 before, and 12 weeks of revenue.

Needs the commerce:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
orders
required
object
value
required
number
change
required
number
trend
required
Array<number>
revenue
required
object
value
required
number
change
required
number
trend
required
Array<number>
averageOrder
required
object
value
required
number
change
required
number
trend
required
Array<number>
refundRate
required
object
value
required
number
change
required
number
trend
required
Array<number>
weeks
required
Array<object>
object
week
required
string format: date-time
revenue
required
number
orders
required
number

Example generated

{
  "orders": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "revenue": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "averageOrder": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "refundRate": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "weeks": [
    {
      "week": "2026-04-15T12:00:00Z",
      "revenue": 1,
      "orders": 1
    }
  ]
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}