Retrieve Metric

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const stat = await client.stats.retrieve('metric', { from: 'from', to: 'to' });

console.log(stat.data);

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

import requests

url = "https://api.whop.com/api/v1/stats/{metric}"

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

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/stats/{metric}",
  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.whop.com/api/v1/stats/{metric}"

	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.whop.com/api/v1/stats/{metric}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/stats/{metric}")

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

{
  "data": {
    "points": [
      {
        "timestamp": 123,
        "value": 123,
        "breakdown": [
          {
            "name": "<string>",
            "value": 123
          }
        ]
      }
    ],
    "currency": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

GET

stats

{metric}

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const stat = await client.stats.retrieve('metric', { from: 'from', to: 'to' });

console.log(stat.data);

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

import requests

url = "https://api.whop.com/api/v1/stats/{metric}"

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

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/stats/{metric}",
  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.whop.com/api/v1/stats/{metric}"

	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.whop.com/api/v1/stats/{metric}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/stats/{metric}")

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

{
  "data": {
    "points": [
      {
        "timestamp": 123,
        "value": 123,
        "breakdown": [
          {
            "name": "<string>",
            "value": 123
          }
        ]
      }
    ],
    "currency": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-07-18"

Path Parameters

metric

string

required

The metric to retrieve, for example net_revenue. Use GET /stats to see every metric key. The metric sets the unit and the properties you can filter or break down by.

Query Parameters

account_id

string

The account this query concerns, for example biz_AbC123.

from

string

required

Start of the range — a date (YYYY-MM-DD), expanded to the start of that day, or an ISO 8601 timestamp (for example 2026-07-16T16:37:00Z), used exactly.

string

required

End of the range — a date (YYYY-MM-DD), expanded to the end of that day, or an ISO 8601 timestamp (for example 2026-07-17T16:37:00Z), used exactly.

interval

enum<string>

How wide each point is. Defaults to day. Snapshot metrics are day-only.

Available options:

minute,

five_minutes,

thirty_minutes,

hour,

day,

week,

month,

year

breakdown_by

string

Split the metric out by one of its properties — each point gets a breakdown array. For example breakdown_by=currency returns an entry for usd, an entry for eur, and so on.

convert_to

string

Display currency for money metrics — every amount is converted into this ISO currency using the exchange rate on each period's date. Defaults to usd. For the ads metrics (ad_spend, ad_report), pass the account's ads reporting currency to match the ad entity endpoints. Ignored when you filter or break down by currency (those report the original transaction currency, unconverted).

currency

string

Filter to transactions made in this original ISO currency, for example eur — reported in that currency, not converted. Pair with breakdown_by=currency to split a metric by currency. Available on metrics that list currency.

time_zone

string

IANA time zone to bucket the series in, for example America/New_York. Defaults to UTC. Not accepted by snapshot metrics, which are UTC only.

payment_method

string

Filter to a single payment method, for example card or crypto. Available on metrics that list payment_method.

card_network

string

Filter to a single card brand, for example visa. A refinement of payment_method=card. Available on metrics that list card_network.

dispute_reason

string

Filter disputes to a normalized reason, for example product_not_received. Pair with breakdown_by=dispute_reason to split dispute counts by reason.

source

string

Filter to a single GMV source, for example payments — or, on the traffic metrics, a visit source (whop_ads, direct, or a utm_source value). Pair with breakdown_by=source to split by source. Available on metrics that list source.

hostname

string

Filter traffic metrics to one website hostname, for example shop.example.com. Pair with breakdown_by=hostname to split by website.

page

string

Filter traffic metrics to one page — a hostname plus normalized path, for example shop.example.com/pricing. Pair with breakdown_by=page to split by page.

device_type

string

Filter traffic metrics to one device type: desktop, mobile, tablet, or unknown. Pair with breakdown_by=device_type to split by device.

country_code

string

Filter traffic metrics to one visitor country (uppercase ISO 3166-1 alpha-2, for example US). Pair with breakdown_by=country_code to split by country.

event_name

string

Filter the events metric to one tracked event name, for example pixel.page or pixel.custom. Pair with breakdown_by=event_name to split by event.

event_type

enum<string>

Filter the events metric to a canonical group of events: page_view (pixel page views plus whop.com store views), checkout_start (hosted and embedded checkout views), or other. Pair with breakdown_by=event_type to split by group.

Available options:

page_view,

checkout_start,

other

custom_name

string

Filter the events metric to one merchant-defined custom event name. Only valid alongside event_name=pixel.custom. Pair with breakdown_by=custom_name to split custom events by name.

segment

string

Filter to a single wallet-balance segment, for example available. Pair with breakdown_by=segment to split the balance. Available on metrics that list segment.

Response

a user-scoped metric via a scoped OAuth token

data

object

required

Show child attributes

List Metrics

Ledger Activity

⌘I

Introduction

Reference

Core Resources

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Authorizations

Headers

Path Parameters

Query Parameters

Response