List domain events
GET
/v1/email/domains/{domain_id}/events
curl -X GET "https://us1.platform.bird.com/v1/email/domains/{domain_id}/events" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25"Returns the domain's activity history, newest first by default: registration, configuration changes (settings, return path, tracking), and every verification status transition for the domain and its individual DNS records. Use it to see when and why a domain's status changed, rather than polling Get a sending domain.
Parameter
domain_id
string
Domain ID.
Abfrageparameter
sort
string
Field to sort by.
Possible values: created_at
order
string
Sort direction. Defaults to desc (newest/largest first).
Possible values: asc, desc
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Antwort-Payload
data
array of object
erforderlich
Page of domain events, newest first by default.
Untergeordnete Attribute anzeigen
data.id
string
erforderlich
Event ID.
data.type
string
erforderlich
Type of domain event. domain.status_changed tracks ownership verification (the domain-level status); domain.sending_status_changed tracks readiness to send (capabilities.sending); the remaining *_status_changed types each track one DNS record's verification. Open enum: new event types may be added over time, so treat any unrecognized value as a future event rather than an error. The values below are the types known at this version.
Possible values (may grow over time): domain.registered, domain.settings_updated, domain.return_path_changed, domain.tracking_changed, domain.tracking_removed, domain.status_changed, domain.sending_status_changed, domain.dkim_status_changed, domain.dmarc_status_changed, domain.return_path_status_changed, domain.tracking_status_changed
data.summary
string
erforderlich
Human-readable summary of what changed.
data.metadata
object
erforderlich
Structured details for the event. Status-change events carry from and to; record-level changes also carry domain, the affected hostname.
data.created_at
string
erforderlich
When the event was recorded.
next_cursor
nullable string
erforderlich
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
erforderlich
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
erforderlich
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.