Skip to content
digizeDocs

Dashboard

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

The workspace at a glance: revenue, orders, visitors and new contacts over the last 30 days against the 30 before, revenue per day, best sellers, where visitors came from, and what needs someone’s attention in each module.

Needs the analytics:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
revenue
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>
orders
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>
newContacts
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>
visitors
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>
days
required
Array<object>
object
date
required
string format: date-time
revenue
required
number
orders
required
number
attention
required

Each kind of thing with some waiting: orders to ship, products running low, unread conversations, failed deployments, orders marked for attention, disputes, integrations in error.

Array<object>
object
kind
required
string
Allowed values: unfulfilled low_stock unread failed_runs deposits_due overdue_invoices unanswered_reviews domains failed_deploys orders_attention disputes integrations
count
required
number
topProducts
required
Array<object>
object
id
required
string
name
required
string
sold
required
number
revenue
required
number
sources
required
Array<object>
object
label
required
string
value
required
number
share
required

Its part of the breakdown, from 0 to 1.

number
unavailable
required
Any of:
object
reason
required
string
Allowed values: token permission upstream
message
required
string

Example 

{
  "attention": [
    {
      "kind": "unfulfilled"
    }
  ],
  "unavailable": {
    "reason": "token"
  }
}

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"
  }
}