Usage events report

GET/api/v1/usage_events/report

Aggregates events into a gapless time series: every bucket in the window appears, zero-filled when empty, so the response charts directly. Non-numeric property values are skipped in numeric calculations rather than erroring.

Query parameters

eventNamestring

Which event to aggregate; omit for all.

calculationstring

count, distinct_customers, sum, avg, min, or max.

overPropertystring

The numeric property for sum/avg/min/max; required for those calculations.

periodstring

daily (default), weekly, or monthly buckets.

customerIdstring

Filter to one shop.

startDatestring

Window start; defaults to 30 days ago. endDate works the same.

Returns

200The aggregate total plus the bucketed series.

400Numeric calculation without overProperty, or unknown calculation/period.

401Bad or missing X-Api-Key.

Request

cURL

curl -H "X-Api-Key: $API_KEY" \
  "https://partnerconsole.co/api/v1\
/usage_events/report?eventName=quote_created\
&calculation=sum&overProperty=value&period=daily"

Node.js

const params = new URLSearchParams({
  eventName: 'quote_created',
  calculation: 'sum',
  overProperty: 'value',
  period: 'daily',
});
const res = await fetch(
  'https://partnerconsole.co/api/v1' +
    `/usage_events/report?${params}`,
  {headers: {'X-Api-Key': process.env.PC_API_KEY}},
);
const {total, series} = await res.json();

Python

import os, requests

res = requests.get(
    "https://partnerconsole.co/api/v1"
    "/usage_events/report",
    headers={
        "X-Api-Key": os.environ["PC_API_KEY"],
    },
    params={
        "eventName": "quote_created",
        "calculation": "sum",
        "overProperty": "value",
        "period": "daily",
    },
    timeout=10,
)
report = res.json()

Response · 200

{
  "calculation": "sum",
  "period": "daily",
  "overProperty": "value",
  "total": 1240.5,
  "series": [
    {"date": "2026-08-14", "value": 380.0},
    {"date": "2026-08-15", "value": 860.5}
  ]
}