Get transit statistics

GET

https://api-v2.test.eldowallet.fr/transits/stats

Returns statistics on the wallet's transit tickets: total (totalCustomers), active (totalActifCustomers) and redeemed (redeemedPassesCount). Filter by template, transit type or creation period.

Good to know

• The wallet must have the TRANSIT pass type enabled.

Request

query parameters

• transitId string
  Limits the statistics to this transit template. Takes precedence over `transitType`.
• transitType string
  Limits the statistics to templates of this type: `Bus`, `Boat`, `Train`, `Air`, `Generic` or `Tram`.
  enum: Bus, Boat, Train, Air, Generic, Tram
• startDate string <date-time>
  Start of the period (ISO 8601), applied to the passes' creation date.
• endDate string <date-time>
  End of the period (ISO 8601), applied to the passes' creation date.

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema application/json

• totalCustomers number required
  Total customers
• totalActifCustomers number required
  Total active customers
• redeemedPassesCount number required
  Redeemed passes count

401

UNAUTHORIZED

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email