Get paginated statistics

Returns time-series usage statistics with optional grouping, filtering, and pagination. Supports JSON and CSV output formats.

GET /api/v1/stats

Get paginated statistics

cURL

curl --request GET \
  --url https://api.superwhisper.com/api/v1/stats \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.superwhisper.com/api/v1/stats"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.superwhisper.com/api/v1/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.superwhisper.com/api/v1/stats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.superwhisper.com/api/v1/stats"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.superwhisper.com/api/v1/stats")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.superwhisper.com/api/v1/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "time_bucket": "<string>",
      "recording_count": 123,
      "total_words": 123,
      "total_duration": 123,
      "avg_llm_processing_time": 123,
      "avg_voice_processing_time": 123,
      "avg_wpm": 123
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total_rows": 123,
    "total_pages": 123,
    "count": 123
  },
  "meta": {
    "start_date": "<string>",
    "end_date": "<string>",
    "granularity": "<string>",
    "group_by": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API access token (starts with sk-sw-)

Query Parameters

start_date · string

ISO 8601 start date (defaults to 7 days ago)

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$

end_date · string

ISO 8601 end date (defaults to now)

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$

granularity · enum<string>

Time bucket granularity (defaults to day)

Available options: hour, day, week, month

group_by · enum<string>

Dimension to group results by

Available options: member_email, voice_model, language_model, app_name

page · integer

Page number (defaults to 1)

Required range: x >= 1

page_size · integer

Results per page, max 1000 (defaults to 200)

Required range: 1 <= x <= 1000

format · enum<string>

Response format (defaults to json)

Available options: json, csv

filter[member_email] · string

Comma-separated member email addresses

filter[voice_model] · string

Comma-separated voice models

filter[language_model] · string

Comma-separated language models

filter[app_name] · string

Comma-separated app names

Response

200

application/json

Paginated statistics (or CSV file when format=csv)

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes

meta · object · required

Show child attributes