Plan, entitlements, and month-to-date event volume
The tier this account is on, the features it includes, and how many events have been ingested this calendar month against the quota that was bought. Measured live at request time rather than served from a cached daily sweep, so a check straight after a traffic spike reflects it.
The quota is a SOFT cap. Being over it is a billing signal, never a stop: ingestion continues, no events are dropped, and no endpoint starts failing.
buckets holds one entry per quota in force. Normally that is a single agency bucket that every location draws from. A location placed on its own plan is metered separately in its own location bucket and its events leave the agency pool, so the same events are never counted against two quotas.
curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/agency/quota?month_offset=0" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://mythic-analytics.gulp.workers.dev/client/v1/agency/quota?month_offset=0"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://mythic-analytics.gulp.workers.dev/client/v1/agency/quota?month_offset=0", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://mythic-analytics.gulp.workers.dev/client/v1/agency/quota?month_offset=0", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://mythic-analytics.gulp.workers.dev/client/v1/agency/quota?month_offset=0')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"month_offset": 0,
"plan": {
"id": "growth",
"name": "Growth",
"features": [
"example_string"
],
"unlimited": false,
"monthly_event_quota": 10000000
},
"buckets": [
{
"scope": "agency",
"plan_id": "growth",
"location_id": "example_string",
"locations": 42,
"unresolved_plan_id": "example_string",
"metered": true,
"used": 8412663,
"quota": 10000000,
"ratio": 0.841,
"over": false,
"threshold": 0.8
}
],
"locations": 12,
"soft_cap": true
}
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Error",
"message": "Plan or quota lookup failed",
"code": 502
}
/client/v1/agency/quota
Target server for requests. Edit to use your own host.
Agency key (ak_) only — a location secret key (sk_) gets 403 agency_required. Keys are server-side credentials; this surface serves no CORS headers on purpose. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need agency:read; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
ak_) only — a location secret key (sk_) gets 403 agency_required. Keys are server-side credentials; this surface serves no CORS headers on purpose. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need agency:read; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.0 = current calendar month (default), 1 = previous, up to 12.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Agency key (ak_) only — a location secret key (sk_) gets 403 agency_required. Keys are server-side credentials; this surface serves no CORS headers on purpose. Agency-wide scoped keys (mcp_ with no fixed location) are accepted too and need agency:read; a client-bound mcp_ key gets 403 agency_key_required. See Using an mcp_ key over HTTP.
Query Parameters
0 = current calendar month (default), 1 = previous, up to 12.