Skip to main content
GET
/
stats
/
by-period
cURL
curl --request GET \
  --url https://www.getinboxzero.com/api/v1/stats/by-period \
  --header 'API-Key: <api-key>'
{
  "result": [
    {
      "startOfPeriod": "<string>",
      "All": 123,
      "Sent": 123,
      "Read": 123,
      "Unread": 123,
      "Unarchived": 123,
      "Archived": 123
    }
  ],
  "allCount": 123,
  "inboxCount": 123,
  "readCount": 123,
  "sentCount": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.getinboxzero.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
API-Key
string
header
required

Query Parameters

​
period
enum<string>
default:week
Available options:
day,
week,
month,
year
​
fromDate
number | null
​
toDate
number | null

Response

200 - application/json

Successful response

​
result
object[]
required
​
allCount
number
required
​
inboxCount
number
required
​
readCount
number
required
​
sentCount
number
required