GEgetinboxzero

GET /stats/by-period

Changed on

Get email statistics grouped by time period. Returns counts of emails by status (all, sent, read, unread, archived, unarchived) for each period.

Request

  • Base URL
    https://www.getinboxzero.com/api/v1
  • URL
    https://www.getinboxzero.com/api/v1/stats/by-period
  • Auth
    API key in header API-Key

Query parameters

period'day' | 'week' | 'month' | 'year'
fromDatenumber nullable
toDatenumber nullable

Response

Successful response

allCountnumber required
inboxCountnumber required
readCountnumber required
sentCountnumber required

Changes

  • 1d998f18f91bRevision changes
    • info

      api operation id getStatsByPeriod was added

    • info

      the security scope STATS_READ was added to the endpoint's security scheme ApiKeyAuth

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status