RESTful API for accessing tenant-scoped reporting data including usage records, active bundles, bundle instances, and endpoint information. All data is automatically scoped to your tenant via Cloudflare Access service tokens.
https://simsy-reporting-api.jim-42e.workers.dev/api/v1
All requests must include Cloudflare Access service token headers. Your tenant is automatically identified from the token.
# Required headers for all requests
CF-Access-Client-Id: <your-client-id>
CF-Access-Client-Secret: <your-client-secret>
Content-Type: application/jsonReturns aggregated usage data for the authenticated tenant. Supports time-based filtering and grouping.
from
Start date for the report period. Default: 30 days ago.
to
End date for the report period. Default: now.
group_by
Grouping period: daily, monthly, or annual. Default: daily.
{
"tenant": "Allsee Technologies Limited",
"period": { "from": "2025-09-01T00:00:00Z", "to": "2025-10-01T00:00:00Z" },
"summary": {
"total_data_mb": 2457600,
"total_records": 45823,
"active_endpoints": 1293
},
"data": [
{ "date": "2025-09-01", "data_mb": 78450, "records": 1523 },
{ "date": "2025-09-02", "data_mb": 82100, "records": 1601 }
]
}# Get monthly usage for Q3 2025
curl -X GET \
"https://simsy-reporting-api.jim-42e.workers.dev/api/v1/usage/summary?from=2025-07-01&to=2025-10-01&group_by=monthly" \
-H "CF-Access-Client-Id: $CLIENT_ID" \
-H "CF-Access-Client-Secret: $CLIENT_SECRET"Returns paginated usage records for the authenticated tenant. Supports filtering by ICCID, date range, and endpoint.
iccid
Filter by specific ICCID.
page
Page number (default: 1). Each page returns 100 records.
from
to
Returns all active bundles for the authenticated tenant with status breakdown and pagination.
status
Filter by status: active, provisioning, expiring, expired
page
Page number (default: 1)
Returns full details of a specific bundle, including all associated instances and usage data.
Returns bundle instances for the tenant. Filterable by ICCID, bundle, status, and date range.
iccid
Filter by ICCID
bundle_id
Filter by bundle ID
status
Status filter: active, completed, pending
Returns all endpoints associated with the authenticated tenant, including status and usage summary.
Returns usage data filtered to a specific endpoint. Supports date range and grouping parameters.
Generate a bulk data export in CSV or JSON format. Returns a download URL valid for 1 hour.
{
"report_type": "usage", // "usage" | "bundles" | "instances" | "endpoints"
"format": "csv", // "csv" | "json"
"from": "2025-01-01T00:00:00Z",
"to": "2025-10-01T00:00:00Z",
"filters": {
"iccid": "8944...", // optional
"endpoint_id": "ep-123" // optional
}
}API requests are rate-limited to 100 requests per minute per tenant. Export operations count as 5 requests. Rate limit headers are included in all responses:
X-RateLimit-Limit: 100 · X-RateLimit-Remaining: 95 · X-RateLimit-Reset: 1696156800