space.highport.manage.getSiteTraffic
Schema Diff
+27 -23
Compatibility Analysis
Backward Compatible
Backward compatible. 2 non-breaking changes.
Non-Breaking Changes (2)
- AddedVertex AddedVertex { vertex_id: "space.highport.manage.getSiteTraffic:output.buckets:items.botRequests" }
- AddedEdge AddedEdge { src: "space.highport.manage.getSiteTraffic:output.buckets:items", tgt: "space.highport.manage.getSiteTraffic:output.buckets:items.botRequests", kind: "prop", name: Some("botRequests") }
Migration Guidance
Added Elements
AddedVertex { vertex_id: "space.highport.manage.getSiteTraffic:output.buckets:items.botRequests" }
Additional Notes
- Non-breaking: AddedEdge { src: "space.highport.manage.getSiteTraffic:output.buckets:items", tgt: "space.highport.manage.getSiteTraffic:output.buckets:items.botRequests", kind: "prop", name: Some("botRequests") }
1
1
{
2
2
"$type": "com.atproto.lexicon.schema",
3
3
"defs": {
4
4
"main": {
5
-
"description": "Traffic to one domain the caller owns, over a range: requests and bytes per hour, the busiest paths, and the status mix. Byte figures include a flat per-response header estimate, because the edge's access log records the response body only.",
5
+
"description": "Traffic to one of the caller's domains over a time range: hourly requests and bytes, the busiest paths, and status codes. Byte figures include a fixed per-response header estimate, since the edge logs only response bodies.",
6
6
"errors": [
7
7
{
8
-
"description": "Not a syntactically valid, non-reserved, public-suffix-safe domain. Distinct from DomainNotFound: the string is not a hostname at all.",
8
+
"description": "Not a valid, non-reserved, public-suffix-safe domain. Unlike DomainNotFound, the input is not a hostname at all.",
9
9
"name": "InvalidDomain"
10
10
},
11
11
{
12
-
"description": "No such domain, or it is not registered to the calling identity. The two are one answer so the method is not an existence oracle.",
12
+
"description": "No such domain, or it does not belong to the caller. Both cases get the same error, so it cannot be used to check whether a domain exists.",
13
13
"name": "DomainNotFound"
14
14
},
15
15
{
16
-
"description": "This deployment has no analytics store configured, so no traffic was ever recorded.",
16
+
"description": "No analytics store is configured, so no traffic was recorded.",
17
17
"name": "AnalyticsDisabled"
18
18
}
19
19
],
20
20
"output": {
21
21
"encoding": "application/json",
22
22
"schema": {
23
23
"properties": {
24
24
"buckets": {
25
25
"description": "Hourly buckets, oldest first.",
26
26
"items": {
27
27
"description": "One hour of a domain's traffic.",
28
28
"properties": {
29
+
"botRequests": {
30
+
"description": "How many of requests came from crawlers. This is part of requests, not added to it. Bytes are not split this way. Absent if the deployment does not report it; show that as unknown, not as zero.",
31
+
"type": "integer"
32
+
},
29
33
"bucket": {
30
-
"description": "The hour this bucket starts.",
34
+
"description": "Start of the hour.",
31
35
"format": "datetime",
32
36
"type": "string"
33
37
},
34
38
"bytesBilled": {
35
39
"description": "Body bytes plus the per-response header estimate.",
36
40
"type": "integer"
37
41
},
38
42
"bytesBody": {
39
-
"description": "Response body bytes, as the edge logged them.",
43
+
"description": "Response body bytes, as logged by the edge.",
40
44
"type": "integer"
41
45
},
42
46
"requests": {
43
47
"description": "Responses in the hour.",
44
48
"type": "integer"
45
49
}
46
50
},
47
51
"required": [
48
52
"bucket",
49
53
"requests",
50
54
"bytesBody",
51
55
"bytesBilled"
52
56
],
53
57
"type": "object"
54
58
},
55
59
"type": "array"
56
60
},
57
61
"bytesBilled": {
58
-
"description": "Total billed bytes over the range.",
62
+
"description": "Total bytes billed over the range.",
59
63
"type": "integer"
60
64
},
61
65
"bytesBilledToVisitors": {
62
-
"description": "How much of bytesBilled an authenticated visitor paid for rather than the owner. Zero unless the domain is on the sender-pays policy.",
66
+
"description": "The part of bytesBilled that signed-in visitors paid instead of the owner. Zero unless the domain uses the visitor payer policy.",
63
67
"type": "integer"
64
68
},
65
69
"domain": {
66
70
"type": "string"
67
71
},
68
72
"headerEstimateBytes": {
69
-
"description": "The flat per-response constant added to every logged body size. Every byte figure here is an estimate by this much per response.",
73
+
"description": "The fixed per-response header estimate added to each logged body size. Every byte figure here is estimated by this much per response.",
70
74
"type": "integer"
71
75
},
72
76
"records": {
73
-
"description": "Which published version of the site record served the traffic, heaviest first. Bounded by topRecords, so a domain republished more often than that has versions this does not list. Absent from a deployment that does not report the split.",
77
+
"description": "Which versions of the site record served the traffic, heaviest first. Limited to topRecords, so a frequently republished domain may have versions not listed. Absent if the deployment does not report it.",
74
78
"items": {
75
-
"description": "One published version, and the traffic the snapshots built from it served.",
79
+
"description": "One published version and the traffic it served.",
76
80
"properties": {
77
81
"bytesBilled": {
78
82
"description": "Billed bytes.",
79
83
"type": "integer"
80
84
},
81
85
"firstSeen": {
82
-
"description": "The first response inside the range served from this version.",
86
+
"description": "The first response in the range served from this version.",
83
87
"format": "datetime",
84
88
"type": "string"
85
89
},
86
90
"lastSeen": {
87
-
"description": "The last, which with firstSeen is how long the version was serving inside the range — what makes one version's byte figure comparable to another's. Absent where the answer is not known, which a reader shows as still serving rather than as an interval it was not given.",
91
+
"description": "The last response in the range served from this version. With firstSeen, it shows how long the version served, so byte figures can be compared across versions. Absent when unknown; show that as still serving.",
88
92
"format": "datetime",
89
93
"type": "string"
90
94
},
91
95
"recordCid": {
92
-
"description": "The site record the serving snapshot was built from. Every response already names it, so the split needs nothing tagged.",
96
+
"description": "The site record the serving snapshot was built from.",
93
97
"format": "cid",
94
98
"type": "string"
95
99
},
96
100
"requests": {
97
101
"description": "Responses.",
98
102
"type": "integer"
99
103
}
100
104
},
101
105
"required": [
102
106
"recordCid",
103
107
"firstSeen",
104
108
"requests",
105
109
"bytesBilled"
106
110
],
107
111
"type": "object"
108
112
},
109
113
"type": "array"
110
114
},
111
115
"refusals": {
112
-
"description": "What the bandwidth allowance refused over the range, and what serving it would have cost. Absent from a deployment that does not report it.",
116
+
"description": "What the bandwidth allowance refused over the range, and what serving it would have cost. Absent if the deployment does not report it.",
113
117
"properties": {
114
118
"estimatedBytes": {
115
-
"description": "What serving those responses instead would have charged the owner. Absent unless the deployment records it: a refusal transferred no body, so its cost is in no logged size, and only the edge knows how large the path it refused would have been.",
119
+
"description": "What serving those responses would have cost the owner. Absent unless the deployment records it, because a refused response has no logged body size.",
116
120
"type": "integer"
117
121
},
118
122
"requests": {
119
-
"description": "Responses refused because the payer's allowance for the period was spent. The same responses the status mix counts as 402, taken from the same read so the two figures cannot disagree.",
123
+
"description": "Responses refused because the payer's allowance for the period ran out. Matches the 402 count in statuses.",
120
124
"type": "integer"
121
125
}
122
126
},
123
127
"required": [
124
128
"requests"
125
129
],
126
130
"type": "object"
127
131
},
128
132
"statuses": {
129
-
"description": "The status mix, with the crawler share alongside it.",
133
+
"description": "Requests by status code, with the crawler share.",
130
134
"items": {
131
-
"description": "One status code's share of the requests and of the bytes.",
135
+
"description": "One status code's share of requests and bytes.",
132
136
"properties": {
133
137
"botRequests": {
134
-
"description": "How many of those came from a client classified as a crawler. Crawler traffic is billed, because it is real egress and the alternative rewards user-agent spoofing.",
138
+
"description": "How many of those came from crawlers. Crawler traffic is billed: it is real egress, and not billing it would reward faking a user agent.",
135
139
"type": "integer"
136
140
},
137
141
"bytesBilled": {
138
142
"description": "Billed bytes.",
139
143
"type": "integer"
140
144
},
141
145
"requests": {
142
146
"description": "Responses with this status.",
143
147
"type": "integer"
144
148
},
145
149
"status": {
146
150
"description": "The HTTP status.",
147
151
"type": "integer"
148
152
}
149
153
},
150
154
"required": [
151
155
"status",
152
156
"requests",
153
157
"bytesBilled",
154
158
"botRequests"
155
159
],
156
160
"type": "object"
157
161
},
158
162
"type": "array"
159
163
},
160
164
"topPaths": {
161
165
"description": "The busiest paths over the range.",
162
166
"items": {
163
-
"description": "One path and what it cost.",
167
+
"description": "One path and its traffic.",
164
168
"properties": {
165
169
"bytesBilled": {
166
170
"description": "Billed bytes.",
167
171
"type": "integer"
168
172
},
169
173
"path": {
170
174
"description": "The request path.",
171
175
"type": "string"
172
176
},
173
177
"requests": {
174
178
"description": "Responses.",
175
179
"type": "integer"
176
180
}
177
181
},
178
182
"required": [
179
183
"path",
180
184
"requests",
181
185
"bytesBilled"
182
186
],
183
187
"type": "object"
184
188
},
185
189
"type": "array"
186
190
}
187
191
},
188
192
"required": [
189
193
"domain",
190
194
"bytesBilled",
191
195
"bytesBilledToVisitors",
192
196
"headerEstimateBytes",
193
197
"buckets",
194
198
"topPaths",
195
199
"statuses"
196
200
],
197
201
"type": "object"
198
202
}
199
203
},
200
204
"parameters": {
201
205
"properties": {
202
206
"domain": {
203
-
"description": "The registered hostname. Must be registered to the calling identity.",
207
+
"description": "The registered hostname. Must belong to the caller.",
204
208
"maxLength": 253,
205
209
"type": "string"
206
210
},
207
211
"from": {
208
212
"description": "Inclusive lower bound. Defaults to 30 days ago.",
209
213
"format": "datetime",
210
214
"type": "string"
211
215
},
212
216
"to": {
213
217
"description": "Exclusive upper bound. Defaults to now.",
214
218
"format": "datetime",
215
219
"type": "string"
216
220
},
217
221
"topPaths": {
218
222
"default": 20,
219
223
"description": "How many of the busiest paths to return.",
220
224
"maximum": 100,
221
225
"minimum": 0,
222
226
"type": "integer"
223
227
},
224
228
"topRecords": {
225
229
"default": 20,
226
-
"description": "How many published record versions to return. A record CID is not a small set: a domain republished often has one per publish, so this is a top-N and not the whole history.",
230
+
"description": "How many record versions to return. A domain republished often has many, so this is a top N, not the full history.",
227
231
"maximum": 100,
228
232
"minimum": 0,
229
233
"type": "integer"
230
234
}
231
235
},
232
236
"required": [
233
237
"domain"
234
238
],
235
239
"type": "params"
236
240
},
237
241
"type": "query"
238
242
}
239
243
},
240
244
"id": "space.highport.manage.getSiteTraffic",
241
245
"lexicon": 1
242
246
}