Skip to content
digizeDocs

Booking numbers

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

Appointments in the next 7 days, what the next 30 days’ are worth, deposits taken and the no-show rate over the last 30.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
upcoming
required
object
value
required
number
change
required
number
trend
required
Array<number>
people
required
number
booked
required
object
value
required
number
change
required
number
trend
required
Array<number>
deposits
required
object
value
required
number
change
required
number
trend
required
Array<number>
noShowRate
required
object
value
required
number
change
required
number
trend
required
Array<number>

Example generated

{
  "upcoming": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ],
    "people": 1
  },
  "booked": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "deposits": {
    "value": 1,
    "change": 1,
    "trend": [
      1
    ]
  },
  "noShowRate": {
    "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"
  }
}