Usage
GET /v1/usage returns your workspace’s plan and what it has used in the current calendar month (UTC). Use it to show usage in your own app or to warn before you reach the location limit.
Get usage
GET /v1/usage
curl https://api.prismareviews.com/v1/usage \
-H "Authorization: Bearer $PRISMA_API_KEY"const res = await fetch("https://api.prismareviews.com/v1/usage", {
headers: { Authorization: "Bearer " + process.env.PRISMA_API_KEY },
});
const usage = await res.json();
console.log(`${usage.locations.used} of ${usage.locations.limit} locations`);import os
import requests
usage = requests.get(
"https://api.prismareviews.com/v1/usage",
headers={"Authorization": f"Bearer {os.environ['PRISMA_API_KEY']}"},
timeout=30,
).json()
print(f"{usage['locations']['used']} of {usage['locations']['limit']} locations")Response 200
{
"plan": "beam",
"period": "2026-10",
"locations": { "used": 7, "limit": 10 },
"requests": 18234,
"requests_per_minute_limit": 120,
"replies_published": 412
}| Field | Type | Description |
|---|---|---|
plan | enum | spark, beam, spectrum, aurora or custom. |
period | string | The current month, YYYY-MM in UTC. Counters reset when it changes. |
locations.used | integer | Active live locations. Test locations and disconnected ones are not counted. |
locations.limit | integer | Locations included in your plan: Spark 2, Beam 10, Spectrum 50, Aurora 200. |
requests | integer | API requests this month from all of the workspace’s keys, test keys included. Requests rejected by the rate limit are not counted. |
requests_per_minute_limit | integer | Your per-key rate limit. |
replies_published | integer | Replies published on a platform through Prisma this month, test replies included. |
Billing is by connected locations, not by requests: see Pricing. GET /v1/usage returns the same numbers with a live key and a test key.