Skip to content
digizeDocs

Direct mail numbers

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

Pieces mailed, how many arrived, orders and revenue from mailings’ codes, and spending on lists and mail: the last 30 days against the 30 before, with 12 weeks of trend.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
pieces
required
object
value
required
number
change
required
number
trend
required
Array<number>
deliveryRate
required
object
value
required
number
change
required
number
trend
required
Array<number>
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>
spend
required
object
value
required
number
change
required
number
trend
required
Array<number>

Example generated

{
  "pieces": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "deliveryRate": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "orders": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "revenue": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "spend": {
    "value": 1,
    "change": 1,
    "trend": [
      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"
  }
}