Get reservations analytics

GET 
/api/v2/reservations/analytics

Returns analytics for reservations made across all the users reservations

Request

Query Parameters

business_id uuid[]
start_date date-time
end_date date-time

Responses

200

application/json

Schema

Schema

counts

object

required

Count of reservations per state

booked integer

canceled integer

placed integer

rejected integer

total integer

guests

object

required

unique integerrequired

Count of unique guests

repeated integerrequired

Count of guests that have made more than one reservation

repeated_percent numberrequired

Percent of guests that have made more than one reservation

conversion_rate

object

required

confirmed numberrequired

Percent of confirmed reservations

cancelled numberrequired

Percent of cancelled reservations

pending numberrequired

Percent of pending reservations

popular_time_slot integer

Most popular time slot in seconds in the UTC timezone. It can be converted to a time string, when doing, so you should take the businesses timezone offset into account.

avg_party_size numberrequired

Average party size of the reservations

avg_lead_time number

Average lead time in days

Example (from schema)

{
  "counts": {
    "booked": 0,
    "canceled": 0,
    "placed": 0,
    "rejected": 0,
    "total": 0
  },
  "guests": {
    "unique": 27,
    "repeated": 6,
    "repeated_percent": 22.2222222222
  },
  "conversion_rate": {
    "confirmed": 75.9036144578,
    "cancelled": 22.891566265,
    "pending": 1.2048192771
  },
  "popular_time_slot": 45000,
  "avg_party_size": 4.14285714285,
  "avg_lead_time": 1.92063492063
}

400

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

location stringrequired

Possible values: [query, body, response, param]

Where in the request the error occurred

errors

object[]

required

Array [

path stringrequired

Possible values: non-empty

Path to the property with the error

constraints

object

required

property name* string

Error message

]

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired

HTTP status code

message string

Error message

error string

Error name

Example (from schema)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Loading...