curl --request GET \
--url https://apix.spotzee.com/api/client/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://apix.spotzee.com/api/client/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apix.spotzee.com/api/client/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apix.spotzee.com/api/client/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"results": [
{
"id": "evt_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"name": "order_completed",
"created_at": "2026-04-28T05:14:00.000Z",
"user": {
"external_id": "cust-9f4b21",
"anonymous_id": "anon-2c8a3e"
},
"campaign_id": 123,
"bounce_classification": {
"category": "invalid_recipient",
"severity": "temporary",
"final": true,
"diagnostic": "<string>",
"ruleset": "<string>",
"rule_id": "<string>",
"source_evidence": {},
"classified_at": "2023-11-07T05:31:56Z",
"reason": "matched"
},
"data": {
"order_id": "ord-2048",
"total": 199,
"currency": "AUD"
}
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 50
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}List events
Returns matching user events for a bounded time window. Combine user identifiers, event names, and campaign identifiers to narrow the result set; payloads are included by default.
curl --request GET \
--url https://apix.spotzee.com/api/client/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://apix.spotzee.com/api/client/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apix.spotzee.com/api/client/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apix.spotzee.com/api/client/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"results": [
{
"id": "evt_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"name": "order_completed",
"created_at": "2026-04-28T05:14:00.000Z",
"user": {
"external_id": "cust-9f4b21",
"anonymous_id": "anon-2c8a3e"
},
"campaign_id": 123,
"bounce_classification": {
"category": "invalid_recipient",
"severity": "temporary",
"final": true,
"diagnostic": "<string>",
"ruleset": "<string>",
"rule_id": "<string>",
"source_evidence": {},
"classified_at": "2023-11-07T05:31:56Z",
"reason": "matched"
},
"data": {
"order_id": "ord-2048",
"total": 199,
"currency": "AUD"
}
}
],
"nextCursor": "<string>",
"prevCursor": "<string>",
"limit": 50
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}{
"status": "error",
"code": "resource_missing",
"message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
"error": "<string>",
"title": "Resource missing",
"type": "https://docs.spotzee.com/main-api/errors#resource_missing",
"request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
"param": "id",
"errors": [
{
"param": "email",
"code": "parameter_invalid_format",
"message": "Must be a valid email address."
}
]
}Authorizations
Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.
Query Parameters
Inclusive RFC 3339 start time.
"2026-04-28T00:00:00.000Z"
Exclusive RFC 3339 end time.
"2026-04-29T00:00:00.000Z"
Filter to one or more system-of-record user identifiers.
1001 - 255["cust-9f4b21"]
Filter to one or more anonymous tracking identifiers.
1001 - 255["anon-2c8a3e"]
Filter to one or more event names.
501 - 255["order_completed"]
Filter to one or more numeric campaign identifiers.
25[123]
Optional; false by default. Include classification from stored or retained diagnostic evidence on this page. Historical events are unchanged. An unknown category means evidence is missing, unmatched, or ambiguous; severity and finality describe the recorded failure.
Include the event payload in each result. Defaults to true; set false to omit payloads.
true
Opaque cursor returned by a previous page. Omit on the first request.
2048Maximum events to return. The maximum page size is 100.
1 <= x <= 10050
Event order by occurrence time.
asc, desc Response
A page of matching events.
Hide child attributes
Hide child attributes
Stable, opaque identifier prefixed with evt_.
^evt_[0-9A-HJKMNP-TV-Z]{26}$"evt_01HXY7Z9K8M5J2N4P6Q8R0S1T2"
Event name.
"order_completed"
Time the event occurred.
"2026-04-28T05:14:00.000Z"
Campaign identifier when the event belongs to a campaign.
123
Present only when include_bounce_classification=true. The unknown category is shown as Unclassified; severity and finality do not imply inbox placement.
Hide child attributes
Hide child attributes
Diagnostic cause identifier. The UI labels unknown as Unclassified and dns_routing_error as DNS or routing error. Unknown is the fallback when evidence does not establish a cause.
invalid_recipient, mailbox_unavailable, mailbox_full, authentication_failed, policy_blocked, spam_rejected, reputation_blocked, rate_limited, content_rejected, dns_routing_error, transport_error, unknown Severity of the diagnostic evidence, independent of finality. A temporary diagnostic can accompany a final outcome.
temporary, permanent, unknown Whether this event records a final failure outcome.
2048When the classification was produced; not the event occurrence time or report freshness timestamp.
Why the diagnostic matched a cause or remained unknown. Missing, unmatched and ambiguous evidence must not be treated as delivery success.
matched, unmatched, missing_evidence, ambiguous, not_a_bounce Event payload. Present when include_payload=true.
{ "order_id": "ord-2048", "total": 199, "currency": "AUD" }
Cursor for the next page, or null when there is no next page.
Cursor for the previous page, or null when there is no previous page.
Page size used for the response.
50
Was this page helpful?