Skip to content
digizeDocs

Revenue report

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

Gross and net revenue, refunds and average order for the last 30 days against the 30 before; 12 months by sales channel; sales by category and product; subscription orders.

Needs the analytics:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
gross
required
object
value
required
number
change
required

Against the period before, in percent.

number
trend
required

Weekly, the last 12 weeks, oldest first.

Array<number>
refunds
required
object
value
required
number
change
required

Against the period before, in percent.

number
trend
required

Weekly, the last 12 weeks, oldest first.

Array<number>
net
required
object
value
required
number
change
required

Against the period before, in percent.

number
trend
required

Weekly, the last 12 weeks, oldest first.

Array<number>
averageOrder
required
object
value
required
number
change
required

Against the period before, in percent.

number
trend
required

Weekly, the last 12 weeks, oldest first.

Array<number>
months
required
Array<object>
object
month
required
string format: date-time
storefront
required
number
subscription
required
number
checkoutLink
required
number
refunds
required
number
orders
required
number
categories
required
Array<object>
object
label
required
string
value
required
number
products
required
Array<object>
object
id
required
string
name
required
string
category
required
string
units
required
number
orders
required
number
revenue
required
number
subscriptions
required
object
mrr
required
object
value
required
number
change
required

Against the period before, in percent.

number
trend
required

Weekly, the last 12 weeks, oldest first.

Array<number>
active
required
number
started
required
number
lapsed
required
number
churnRate
required
number
months
required
Array<object>
object
month
required
string format: date-time
mrr
required
number

Example generated

{
  "gross": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "refunds": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "net": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "averageOrder": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "months": [
    {
      "month": "2026-04-15T12:00:00Z",
      "storefront": 1,
      "subscription": 1,
      "checkoutLink": 1,
      "refunds": 1,
      "orders": 1
    }
  ],
  "categories": [
    {
      "label": "example",
      "value": 1
    }
  ],
  "products": [
    {
      "id": "example",
      "name": "example",
      "category": "example",
      "units": 1,
      "orders": 1,
      "revenue": 1
    }
  ],
  "subscriptions": {
    "mrr": {
      "value": 1,
      "change": 1,
      "trend": [
        1
      ]
    },
    "active": 1,
    "started": 1,
    "lapsed": 1,
    "churnRate": 1,
    "months": [
      {
        "month": "2026-04-15T12:00:00Z",
        "mrr": 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"
  }
}