Skip to content

Commit 05a6644

Browse files
committed
Updates for parity with Flex topic
1 parent e68711c commit 05a6644

1 file changed

Lines changed: 53 additions & 14 deletions

File tree

sites/platform/src/development/email-observability.md

Lines changed: 53 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,31 @@ To get an access token:
3333

3434
## Query message history
3535

36-
Retrieve a log of delivery events for a project:
36+
Retrieve a log of email events for a project:
3737

3838
```bash
3939
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/messages/get/platformsh-auth/{{< variable "PROJECT_ID" >}}" \
4040
-H "Authorization: Bearer {{< variable "ACCESS_TOKEN" >}}" \
4141
-H "accept: application/json" | jq '.'
4242
```
4343

44-
Filter by date range using `from_date` and `to_date` (format: `YYYY-MM-DD`):
44+
Example filtering by a specific month:
4545

4646
```bash
47-
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/messages/get/platformsh-auth/{{< variable "PROJECT_ID" >}}?from_date=2025-01-01&to_date=2025-01-31&limit=50" \
47+
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/messages/get/platformsh-auth/{{< variable "PROJECT_ID" >}}?from_date=2026-03-01&to_date=2026-03-31&limit=50" \
4848
-H "Authorization: Bearer {{< variable "ACCESS_TOKEN" >}}" \
4949
-H "accept: application/json" | jq '.'
5050
```
5151

52+
### Parameters
53+
54+
| Parameter | Default | Description |
55+
|-------------|---------|-------------|
56+
| `limit` | `30` | Number of records to return. |
57+
| `offset` | `0` | Number of records to skip for pagination. |
58+
| `from_date` || Start date filter (`YYYY-MM-DD`). |
59+
| `to_date` || End date filter (`YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS`). |
60+
5261
### Filter by recipient
5362

5463
Retrieve events for one or more specific email addresses:
@@ -61,50 +70,72 @@ curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/messages/email/platformsh-auth/
6170

6271
### Filter by event type
6372

64-
Retrieve events of a specific type.
65-
Supported values: `processed`, `delivered`, `bounce`, `deferred`, `dropped`, `spamreport`, `open`, `click`.
73+
Retrieve events of a specific type by passing `event_type` as a path segment in the URL.
6674

67-
Example `bounce` event type:
75+
Example filtering by `bounce` events:
6876

6977
```bash
7078
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/messages/bounce/platformsh-auth/{{< variable "PROJECT_ID" >}}" \
7179
-H "Authorization: Bearer {{< variable "ACCESS_TOKEN" >}}" \
7280
-H "accept: application/json" | jq '.'
7381
```
7482

83+
#### Parameters
84+
85+
| Parameter | Description |
86+
|--------------|-------------|
87+
| `event_type` | One of `processed`, `delivered`, `bounce`, `deferred`, `dropped`, `spamreport`, `open`, `click`. |
88+
89+
The `limit`, `offset`, `from_date`, and `to_date` parameters from the [previous section](#parameters) also apply.
90+
7591
## View delivery statistics
7692

77-
Retrieve aggregated daily statistics for a project. Defaults to the last 30 days.
93+
Retrieve aggregated daily delivery statistics for a project. This endpoint provides high-level metrics compatible with common visualization tools.
7894

7995
```bash
8096
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/stats/platformsh-auth/{{< variable "PROJECT_ID" >}}" \
8197
-H "Authorization: Bearer {{< variable "ACCESS_TOKEN" >}}" \
8298
-H "accept: application/json" | jq '.'
8399
```
84100

85-
Use `start_date` and `end_date` to narrow the range (format: `YYYY-MM-DD`):
101+
Example narrowing the range to a specific month:
86102

87103
```bash
88-
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/stats/platformsh-auth/{{< variable "PROJECT_ID" >}}?start_date=2025-01-01&end_date=2025-01-31" \
104+
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/stats/platformsh-auth/{{< variable "PROJECT_ID" >}}?start_date=2026-03-01&end_date=2026-03-31" \
89105
-H "Authorization: Bearer {{< variable "ACCESS_TOKEN" >}}" \
90106
-H "accept: application/json" | jq '.'
91107
```
92108

109+
### Parameters
110+
111+
| Parameter | Default | Description |
112+
|--------------|-------------|-------------|
113+
| `start_date` | 30 days ago | Start of the date range (`YYYY-MM-DD`). |
114+
| `end_date` | Today | End of the date range (`YYYY-MM-DD`). |
115+
93116
## Manage suppression lists
94117

95118
Suppression lists prevent sending to addresses that have bounced or blocked your emails.
96119

97120
### Bounces
98121

99-
List addresses that have hard-bounced:
122+
The bouncelist contains addresses that have hard-bounced. The system automatically suppresses further sending attempts to these addresses.
123+
124+
#### List bounced addresses
100125

101126
```bash
102-
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/bouncelist/platformsh-auth/{{< variable "PROJECT_ID" >}}" \/{{< variable "PROJECT_ID" >}}" \
127+
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/bouncelist/platformsh-auth/{{< variable "PROJECT_ID" >}}" \
103128
-H "Authorization: Bearer {{< variable "ACCESS_TOKEN" >}}" \
104129
-H "accept: application/json" | jq '.'
105130
```
106131

107-
Remove an address from the bounce list only after confirming the address is valid:
132+
| Parameter | Default | Description |
133+
|-----------|---------|-------------|
134+
| `limit` | `50` | Number of records to return. |
135+
136+
#### Remove from bouncelist
137+
138+
Only remove an address after confirming it is now valid. Returns `204 No Content` on success.
108139

109140
```bash
110141
curl -X DELETE "https://sendgrid.pltfrm.sh/api/v1/sendgrid/bouncelist/platformsh-auth/{{< variable "PROJECT_ID" >}}" \
@@ -115,15 +146,23 @@ curl -X DELETE "https://sendgrid.pltfrm.sh/api/v1/sendgrid/bouncelist/platformsh
115146

116147
### Blocks
117148

118-
List addresses that have blocked your emails or marked them as spam:
149+
The blocklist prevents sending to addresses that have previously blocked your emails or marked them as spam, protecting your sender reputation.
150+
151+
#### List blocked addresses
119152

120153
```bash
121154
curl "https://sendgrid.pltfrm.sh/api/v1/sendgrid/blocklist/platformsh-auth/{{< variable "PROJECT_ID" >}}" \
122155
-H "Authorization: Bearer {{< variable "ACCESS_TOKEN" >}}" \
123156
-H "accept: application/json" | jq '.'
124157
```
125158

126-
Remove an address from the block list to resume sending:
159+
| Parameter | Default | Description |
160+
|-----------|---------|-------------|
161+
| `limit` | `50` | Number of records to return. |
162+
163+
#### Remove from blocklist
164+
165+
Removes an address to resume sending. Returns `204 No Content` on success.
127166

128167
```bash
129168
curl -X DELETE "https://sendgrid.pltfrm.sh/api/v1/sendgrid/blocklist/platformsh-auth/{{< variable "PROJECT_ID" >}}" \

0 commit comments

Comments
 (0)