--- title: "Get edge analytics for the application's domains" method: GET path: "/v2/apps/{appId}/network/analytics" tags: ["Network"] --- # Get edge analytics for the application's domains `GET /v2/apps/{appId}/network/analytics` Returns aggregated edge analytics (requests, bandwidth, status codes, etc.) for the application's primary domain and any configured custom domain. Requires both `start` and `end` ISO timestamps. Maximum retention window is 7 days; the start is clamped to the application's creation date. Optional drill-down filters (`country`, `ip`, `path`, `status`, `os`, `browser`, `protocol`, `referer`, `provider`, `content_type`, `bot`) narrow every breakdown to the matching traffic — feed back the exact `type` value returned by the corresponding breakdown in a previous response. Filters combine (AND). Results are cached per bucket; on cache miss rate-limited to 10 calls per 60s per owner. ## Path parameters - `appId` string, required ## Query parameters - `start` string, date-time, required - `end` string, date-time, required - `country` string - `ip` string - `path` string - `status` string - `os` string - `browser` string - `protocol` string - `referer` string - `provider` string - `content_type` string - `bot` string ## Response `200` Aggregated edge analytics broken down by time, country, device, OS, browser, protocol, HTTP method, request path, referer, and client ASN — each as an array of buckets (`type` identifies the dimension; `visits` is unique visitors, `requests` is the request count, `bytes` is the response bytes served, `date` is the 15-minute window start). Plus four window-total breakdowns without `date` (top-N over the whole window): `ips` (top client IPs), `status_codes`, `bots` (verified bot categories; `Unverified` is regular traffic) and `content_types`. Returns an empty object (`{}`) when the requested window starts before the application's creation date. - object - `status` 'success', required - `response` union, required - NetworkAnalytics - `visits` NetworkAnalyticsTimeBucket[], required - `visits` integer, required - `requests` integer, required - `bytes` integer, required - `date` string, date-time, required — Start of the 15-minute window. - `countries` NetworkAnalyticsBucket[], required - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `devices` NetworkAnalyticsBucket[], required - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `os` NetworkAnalyticsBucket[], required - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `browsers` NetworkAnalyticsBucket[], required - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `protocols` NetworkAnalyticsBucket[], required - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `methods` NetworkAnalyticsBucket[], required - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `paths` NetworkAnalyticsBucket[], required - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `referers` NetworkAnalyticsBucket[], required — Referer breakdown. Empty referer strings are normalized to `type: "Direct"`. - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `providers` NetworkAnalyticsBucket[], required — ASN breakdown. Square Cloud's own ASN is normalized to `type: "SQUARE-CLOUD-PLATFORM"`. - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `date` string, date-time, required — Start of the 15-minute window. - `ips` NetworkAnalyticsTotalBucket[], required — Top client IPs by request count over the whole window. IPs originating from Square Cloud's own network are masked (`X.X.XXX.XXX`). - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `status_codes` NetworkAnalyticsTotalBucket[], required — Edge response status codes over the whole window (all classes, not just errors). - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `bots` NetworkAnalyticsTotalBucket[], required — Verified-bot categories over the whole window. Traffic without a verified bot category is `type: "Unverified"`. - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - `content_types` NetworkAnalyticsTotalBucket[], required — Response content types over the whole window. Unknown content types are `type: "Unknown"`. - `type` string, required — Dimension value for this bucket. - `visits` integer, required — Unique visitor count. - `requests` integer, required — Total request count. - `bytes` integer, required — Response bytes served. - object — Empty when the window precedes app creation. ## Other responses - `400` — `start`/`end` are missing, malformed, invert the time range, or a drill-down filter is invalid. - `401` — The Authorization header is missing, malformed, or the credentials are not valid. - `404` — The target application could not be found, or the caller is not a member of the workspace. - `429` — Cache miss rate limit exceeded (10 per 60s per owner). - `500` — Failed to fetch analytics from the edge provider. --- [API](https://skmtc.dev/squarecloud/apis/square-cloud-api.md) · [All operations](https://skmtc.dev/squarecloud/apis/square-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/squarecloud/square-cloud-api/revisions/54b7733a6b95/schema)