Site-scoped thread analytics

Site-scoped thread analytics

GET /api/admin/sites/{id}/analytics

cURL

curl --request GET \
  --url 'https://api.example.com/api/admin/sites/{id}/analytics' \
  --header 'Authorization: Bearer YOUR_API_KEY'

200

{
  "skipped": true,
  "orgId": "string",
  "siteId": "string",
  "scope": "string",
  "note": "Two-person tent, green — replacement for damaged pole set.",
  "range": {},
  "limit": 20,
  "analysis": {}
}

Path parameters

id · string · required

Site id

Response

object

skipped · boolean · required

orgId · string

siteId · string

null for an org-wide scope

scope · string

note · string

range · object

null unless a range was requested

limit · integer

analysis · object

The thread-analytics report (same shape as the ResponseCX thread-analytics analysis)

Status codes

Code	Meaning
200	Site-scoped thread analytics
401	Error
404	Error

cURL

curl --request GET \
  --url 'https://api.example.com/api/admin/sites/{id}/analytics' \
  --header 'Authorization: Bearer YOUR_API_KEY'

200

{
  "skipped": true,
  "orgId": "string",
  "siteId": "string",
  "scope": "string",
  "note": "Two-person tent, green — replacement for damaged pole set.",
  "range": {},
  "limit": 20,
  "analysis": {}
}