Application - Network
Website Analytics
Get analytics for a website hosted on Square Cloud. There is a rate limit of 10 uncached requests every 60 seconds.
GET
Website Analytics
The API key for your account. You can find this in your account settings.
Parameters
The ID of the application. You can find this in the URL of your application’s dashboard.
ISO 8601 start timestamp for the analysis window. The maximum retention window is 7 days; the start is clamped to the application’s creation date.
ISO 8601 end timestamp. Must be after
start.Drill-down filters
Optional filters that narrow every breakdown to the matching traffic. Feed back the exacttype value returned by the corresponding breakdown in a previous response. Filters combine (AND).
A single client country (2-character code), as returned in the
countries breakdown.A single client IP (exact IPv4/IPv6 match), as returned in the
ips breakdown.Request paths starting with this prefix (e.g.
/api covers /api/*). Max 256 chars.A single edge response status code (3 digits), as returned in the
status_codes breakdown.A single client OS, as returned in the
os breakdown.A single client browser, as returned in the
browsers breakdown.A single HTTP protocol, as returned in the
protocols breakdown.A single referer host, as returned in the
referers breakdown (Direct = no referer).A single client network, as returned in the
providers breakdown — e.g. GOOGLE (15169), a bare ASN number, or SQUARE-CLOUD-PLATFORM.A single response content type, as returned in the
content_types breakdown (Unknown = unclassified).A single verified-bot category, as returned in the
bots breakdown (Unverified = regular non-bot traffic).Response
This route can send a response in a compressed format, optimizing data transmission.
Indicates whether the call was successful..
success if successful, error if not.Each breakdown is an array of buckets.
type identifies the dimension, visits is unique visitors, requests is the request count, bytes is the response bytes served, and date is the 15-minute window start. The ips, status_codes, bots, and content_types breakdowns are window totals (top-N over the whole window) and carry no date field. Returns an empty object ({}) when the requested window starts before the application’s creation date.Website Analytics

