GET
/
api
/
v1
/
admin
/
analytics
/
overview
Admin analytics overview
curl --request GET \
  --url https://api.example.com/api/v1/admin/analytics/overview
import requests

url = "https://api.example.com/api/v1/admin/analytics/overview"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/admin/analytics/overview', 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.example.com/api/v1/admin/analytics/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/v1/admin/analytics/overview"

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

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.example.com/api/v1/admin/analytics/overview")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/admin/analytics/overview")

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

request = Net::HTTP::Get.new(url)

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

Overview

The “front-page” tile of the admin dashboard. Returns live platform-wide counters computed against the current Mongo collections — total users, active listings, mutual matches, recently-active chats, and the monthly + annual recurring revenue in pence. Unlike the cohorts and locations surfaces, this endpoint does not read from the nightly analytics_daily rollup; it recomputes on demand so the dashboard reflects the current moment. To keep a burst of admin page-loads from hammering Mongo, the snapshot is cached for 60 seconds. A cache hit returns the cached object untouched; a miss recomputes, populates the cache, and returns the fresh snapshot. See Analytics and rollups for the full split between live + rollup paths.
Available to any admin role — SUPER, MODERATOR, and FINANCE all read this surface (mirrors the reports feed and audit-log read paths).

Authentication

Bearer <accessToken> with scope: 'admin' required (requireAdmin).

Path parameters

None.

Query parameters

None.

Request body

None.

Response — 200 OK

FieldTypeNotesExample
totalUsersintegerCount of all users rows. Not filtered by ban/delete status — raw row count.1842
totalActiveListingsintegerCount of current_homes rows with status: 'LIVE' AND ownerTenancyApproved: true.412
totalMatchesintegerCount of matches rows where both savedByA and savedByB are non-null (mutual matches).87
activeChatsintegerCount of conversations with a lastMessageAt in the trailing 7 days.54
mrrintegerMonthly Recurring Revenue in pence. With the single GBP-monthly tier this is count(ACTIVE subscriptions) × monthlyPence.89700
arrintegerAnnual Recurring Revenue in pence. Convenience field — always mrr × 12.1076400
computedAtstringISO 8601 UTC timestamp of when this snapshot was computed. On a cache hit this is the original compute time (up to 60s old).2026-05-23T09:14:08.412Z
{
  "totalUsers": 1842,
  "totalActiveListings": 412,
  "totalMatches": 87,
  "activeChats": 54,
  "mrr": 89700,
  "arr": 1076400,
  "computedAt": "2026-05-23T09:14:08.412Z"
}
computedAt is the truthful “as of” — clients can check Date.now() - computedAt to know how stale the snapshot is. Worst case is 60 seconds.

MVP limitations

  • totalMatches uses the “mutual save” proxy (savedByA && savedByB). When the matching engine adds an explicit MUTUAL status this should switch.
  • mrr/arr assume the single GBP-monthly pricing tier. Mixed-tier or non-GBP pricing requires a per-row summation against app_config.pricing — out of scope for MVP.

Error responses

StatusCodeMeaning
401UNAUTHENTICATEDMissing, malformed, expired, or non-admin-scope token.

See also

curl

curl "https://api.swappr.co.uk/api/v1/admin/analytics/overview" \
  -H "Authorization: Bearer $ADMIN_ACCESS_TOKEN"

Postman

See docs/postman/swappr.postman_collection.jsonAdmin Analytics → Overview.