Get sales stats for this Event

POST 
/event/:guid/salesstats

Retrieve (date based) sales statistics for all Ticket Types related to an Event.

Request

Path Parameters

guid uuidrequired

The guid of the Event.

application/json

Body

Input data

sales string

Possible values: [free_and_paid, free, paid]

Default value: free_and_paid

What type of sales you want to retrieve.

Responses

200

Statistics retrieved.

application/json

Schema

Schema

tickets

object

The Ticket Types with their statistics - keyed by the guid of the Ticket.

:ticket_guid

object

ticket_id stringrequired

The guid of the Ticket Type.

name stringrequired

The name of this Ticket Type.

status stringrequired

Possible values: [auto, sold_out]

The status of the Ticket Type.

sold_count integerrequired

The total amount sold of this Ticket Type.

pending_count integerrequired

The total amount reserved or pending of this Ticket Type.

available_stock integerrequired

The available stock of this Ticket Type, zero is unlimited.

turnover integerrequired

The total revenue of this Ticket Type in cents.

date_info

object

required

The sales stats of this Ticket Type per day - keyed by day (yyyy-mm-dd).

:date

object

amount integerrequired

The total amount sold of this Ticket Type on this day.

turnover integerrequired

The total revenue of this Ticket Type in cents.

Example (from schema)

{
  "tickets": {
    ":ticket_guid": {
      "ticket_id": "string",
      "name": "string",
      "status": "auto",
      "sold_count": 0,
      "pending_count": 0,
      "available_stock": 0,
      "turnover": 0,
      "date_info": {
        ":date": {
          "amount": 0,
          "turnover": 0
        }
      }
    }
  }
}

404

Event not found.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

406

Request is invalid, see error context for validation errors.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...