Get Stats | rray — Transactional Email API

Authentication

AuthorizationBearer

Your RRay API key.

Query parameters

group_byenumOptional

Bucket size: day, week (ISO-8601, Monday-start), or month (calendar).

Allowed values:

lastinteger or nullOptional>=1

Number of buckets to return, including the current (partial) one. Defaults to 1: the current (partial) bucket only. Hard ceilings depend on group_by: day 90, week 52, month 24.

compareenum or nullOptional

Opt-in comparison window. previous: the last buckets immediately preceding the primary window, same alignment rules. Adds previous_totals to the response — omitted entirely when compare is not set, an object of honest zeros when the prior window had no traffic, or null when the prior window starts before the retention horizon (unknown, not zero).

Opt-in comparison window. `previous`: the `last` buckets immediately preceding the primary window, same alignment rules. Adds `previous_totals` to the response — omitted entirely when `compare` is not set, an object of honest zeros when the prior window had no traffic, or `null` when the prior window starts before the retention horizon (unknown, not zero).

Allowed values:

Response

Successful Response

group_byenum

Stats bucket size (GET /v1/stats, query param group_by): day, ISO-8601 week (Monday-start), or calendar month. Exactly one TIME dimension — entity dimensions (e.g. per-workspace breakdown) are a separate, not-yet-supported axis; the name leaves room for those without implying they exist today.

serieslist of objects

totalsobject

Sum of every StatsSeriesBucket field over the requested window.

computed_atdatetime

When these numbers were computed — realtime today (the request time); will become the last rollup-refresh time if/when a rollup table replaces the on-the-fly aggregation, without changing this field’s meaning.

object"stats"Defaults to stats

previous_totalsobject or null

Sum of every StatsSeriesBucket field over the requested window.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

$	curl -G https://api.rray.app/v1/stats \
>	-H "RRay-Workspace-Id: workspace_123abc" \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d compare=previous \
>	-d group_by=week \
>	-d last=4

1	{
2	"group_by": "week",
3	"series": [
4	{
5	"period_start": "2024-03-04T00:00:00Z",
6	"accepted": 1500,
7	"queued": 300,
8	"delivered": 1400,
9	"bounced": 50,
10	"deferred": 30,
11	"failed": 20,
12	"messages_accepted": 1450
13	},
14	{
15	"period_start": "2024-03-11T00:00:00Z",
16	"accepted": 1600,
17	"queued": 250,
18	"delivered": 1550,
19	"bounced": 40,
20	"deferred": 20,
21	"failed": 10,
22	"messages_accepted": 1580
23	},
24	{
25	"period_start": "2024-03-18T00:00:00Z",
26	"accepted": 1700,
27	"queued": 200,
28	"delivered": 1650,
29	"bounced": 30,
30	"deferred": 15,
31	"failed": 5,
32	"messages_accepted": 1680
33	},
34	{
35	"period_start": "2024-03-25T00:00:00Z",
36	"accepted": 1800,
37	"queued": 150,
38	"delivered": 1750,
39	"bounced": 20,
40	"deferred": 10,
41	"failed": 2,
42	"messages_accepted": 1780
43	}
44	],
45	"totals": {
46	"accepted": 6600,
47	"queued": 900,
48	"delivered": 6350,
49	"bounced": 140,
50	"deferred": 75,
51	"failed": 37,
52	"messages_accepted": 6490
53	},
54	"computed_at": "2024-03-28T12:00:00Z",
55	"object": "stats",
56	"previous_totals": {
57	"accepted": 6200,
58	"queued": 1000,
59	"delivered": 6000,
60	"bounced": 180,
61	"deferred": 90,
62	"failed": 50,
63	"messages_accepted": 6100
64	}
65	}

Authentication

Headers

Query parameters

Response

Errors