{"openapi":"3.1.0","info":{"title":"Analytics API","version":"1.0.0","description":"Sites, keys, stats and the trust report. Times are UTC; ranges are [from, to)."},"components":{"schemas":{},"parameters":{}},"paths":{"/v1/me":{"get":{"tags":["account"],"responses":{"200":{"description":"The signed-in user and their workspaces","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces":{"post":{"tags":["workspaces"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80}},"required":["name"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces/{id}":{"patch":{"tags":["workspaces"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80}},"required":["name"]}}}},"responses":{"200":{"description":"Renamed","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces/{id}/members":{"get":{"tags":["workspaces"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Members and pending invitations","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["workspaces"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["owner","member"],"default":"member"}},"required":["email"]}}}},"responses":{"201":{"description":"Added, or invited when they have no account yet","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces/{id}/members/{userId}":{"delete":{"tags":["workspaces"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"userId","in":"path"}],"responses":{"200":{"description":"Removed","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces/{id}/sites":{"get":{"tags":["sites"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Sites of the workspace","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["sites"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"domain":{"type":"string","pattern":"^(?=.{1,253}$)(?:\\*\\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$|^localhost$"},"timezone":{"type":"string","default":"UTC"}},"required":["domain"]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}":{"get":{"tags":["sites"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"The site","content":{"application/json":{"schema":{}}}}}},"patch":{"tags":["sites"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"domain":{"type":"string","pattern":"^(?=.{1,253}$)(?:\\*\\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$|^localhost$"},"timezone":{"type":"string"},"allowed_domains":{"type":"array","items":{"type":"string","pattern":"^(?=.{1,253}$)(?:\\*\\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,63}$|^localhost$"},"maxItems":50},"redact_query_keys":{"type":"array","items":{"type":"string","pattern":"^[a-z0-9_.-]{1,64}$"},"maxItems":100},"heatmaps":{"type":"boolean"}}}}}},"responses":{"200":{"description":"Updated","content":{"application/json":{"schema":{}}}}}},"delete":{"tags":["sites"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Deleted","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/keys":{"get":{"tags":["keys"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"API keys (never the keys themselves)","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["keys"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":80,"default":""},"scopes":{"type":"array","items":{"type":"string","enum":["read","write","manage","ingest"]},"minItems":1}},"required":["scopes"]}}}},"responses":{"201":{"description":"The key, shown this once","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/keys/{keyId}":{"delete":{"tags":["keys"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"uuid"},"required":true,"name":"keyId","in":"path"}],"responses":{"200":{"description":"Revoked","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/overview":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Visitors, visits, page views, bounce rate, engaged time; compare=true adds the previous period","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/timeseries":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Visitors, visits and page views per hour or day (in the requested time zone)","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/pages":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Pages by views, with visitors, entries and engaged time","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/sources":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Where visits came from: by=channel (default), referrer, utm_source, utm_medium, utm_campaign or entry_page","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/geo":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Visits by country, region or city","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/devices":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Visits by device type, browser, OS or language","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/events":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Custom events and conversions by name; name=<event> breaks one down by property","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/crawlers":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Pages read by crawlers: AI training, AI answers, search, other","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/trust":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"How far to trust these numbers: traffic mix, measured loss, refusals, engagement, sample size and a grade","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/realtime":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Visits active in the last 5 minutes and the pages they are on","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stripe":{"get":{"tags":["revenue"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Connection status","content":{"application/json":{"schema":{}}}}}},"put":{"tags":["revenue"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"restricted_key":{"type":"string","pattern":"^rk_(live|test)_[A-Za-z0-9]+$"},"webhook_secret":{"type":"string","pattern":"^whsec_[A-Za-z0-9]+$"}},"required":["restricted_key","webhook_secret"]}}}},"responses":{"200":{"description":"Connected; the last 90 days are imported in the background","content":{"application/json":{"schema":{}}}}}},"delete":{"tags":["revenue"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Disconnected; imported payments are kept","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/revenue":{"get":{"tags":["revenue"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Revenue, refunds, fees and net per currency; attributed revenue by channel and source","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/heatmaps/pages":{"get":{"tags":["heatmaps"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"}],"responses":{"200":{"description":"Pages by clicks, with rage and dead clicks","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/heatmaps":{"get":{"tags":["heatmaps"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":1024},"required":true,"name":"path","in":"query"},{"schema":{"type":"string","enum":["desktop","tablet","mobile"]},"required":false,"name":"viewport","in":"query"}],"responses":{"200":{"description":"One page's heatmap","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/heatmaps/token":{"post":{"tags":["heatmaps"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"A 15-minute token for the overlay on the site","content":{"application/json":{"schema":{}}}}}}},"/v1/heatmaps/data":{"get":{"tags":["heatmaps"],"parameters":[{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":1024},"required":true,"name":"path","in":"query"},{"schema":{"type":"string","enum":["desktop","tablet","mobile"]},"required":false,"name":"viewport","in":"query"},{"schema":{"type":"string","maxLength":300},"required":false,"name":"x-heatmap-token","in":"header"}],"responses":{"200":{"description":"One page's heatmap, for the overlay","content":{"application/json":{"schema":{}}}}}}},"/v1/sites/{id}/stats/changes":{"get":{"tags":["stats"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time"},"required":false,"name":"to","in":"query"},{"schema":{"type":"string"},"required":false,"name":"timezone","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"include_suspicious","in":"query"},{"schema":{"type":"string","enum":["true","false"]},"required":false,"name":"compare","in":"query"},{"schema":{"type":"string","maxLength":1024},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","maxLength":253},"required":false,"name":"source","in":"query"},{"schema":{"type":"string","minLength":2,"maxLength":2},"required":false,"name":"country","in":"query"},{"schema":{"type":"string","enum":["desktop","mobile","tablet","other"]},"required":false,"name":"device","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_source","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_medium","in":"query"},{"schema":{"type":"string","maxLength":256},"required":false,"name":"utm_campaign","in":"query"},{"schema":{"type":"string","maxLength":32},"required":false,"name":"by","in":"query"},{"schema":{"type":"string","enum":["hour","day"]},"required":false,"name":"interval","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":1000},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"What changed against the previous range of the same length: ranked findings with sentences, and the trust grade","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces/{id}/usage":{"get":{"tags":["workspaces"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Plan, limits and this month’s usage","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces/{id}/billing/checkout":{"post":{"tags":["billing"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tier":{"type":"integer","minimum":0,"maximum":5},"period":{"type":"string","enum":["monthly","yearly"]}},"required":["tier","period"]}}}},"responses":{"200":{"description":"A Stripe Checkout URL, or { updated: true } when an existing subscription was changed","content":{"application/json":{"schema":{}}}}}}},"/v1/workspaces/{id}/billing/portal":{"post":{"tags":["billing"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"A Stripe Billing Portal URL","content":{"application/json":{"schema":{}}}}}}}},"webhooks":{}}