List accessible sites for this token
GET /v1/sites
GET
/v1/sites
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” X-Request-Id
string
Optional idempotency/request correlation identifier.
Responses
Section titled “ Responses ”OK
object
items
required
Array<object>
object
siteId
required
string
name
required
string
hostnames
required
Array<string>
status
required
string
product_configuration
required
object
runtime_plan_id
required
string
collection_profile
required
string
collection_profile_effective_at
required
Timestamp from which the current site profile applies to future collection. This is prospective only and does not backfill older events.
string format: date-time
product_retention
required
object
workspace_retention
required
object
kind
required
string
value
integer
unit
string
api_retention_days
integer
technical_retention
required
object
site_data_retention_months
required
integer
api
required
object
availability
required
string
can_create_tokens
required
boolean
allow_reports
required
boolean
allow_goals
required
boolean
allow_tenants
required
boolean
allow_tenant_dimension
required
boolean
retention_days
integer
monthly_included_units
integer
hard_cap_units
integer
rate_limit_rps
integer
max_range_days
required
integer
max_breakdown_limit
required
integer
max_report_limit
required
integer
usage_history_months
required
integer
exports
required
object
csv
required
boolean
level
required
string
dashboard
required
object
hourly_enabled
required
boolean
hourly_level
required
string
essential_level
required
string
standard_level
required
string
breakdowns_standard_level
required
string
breakdowns_high_cardinality_level
required
string
team_management_level
required
string
enabled_surfaces
required
Array<string>
capabilities
required
object
collection
required
object
level
required
string
data_envelope
required
string
maturity
required
string
notes
required
Array<string>
reports
required
object
level
required
string
data_envelope
required
string
maturity
required
string
notes
required
Array<string>
dashboard_surfaces
required
Array<string>
acquisition
required
object
level
required
string
data_envelope
required
string
maturity
required
string
notes
required
Array<string>
advanced_actions
required
object
level
required
string
data_envelope
required
string
maturity
required
string
notes
required
Array<string>
multi_tenant
required
object
level
required
string
data_envelope
required
string
maturity
required
string
notes
required
Array<string>
exports
required
object
level
required
string
data_envelope
required
string
maturity
required
string
notes
required
Array<string>
api
required
object
level
required
string
data_envelope
required
string
maturity
required
string
notes
required
Array<string>
Headers
Section titled “Headers ” X-Request-Id
string
Request identifier for troubleshooting.
Invalid or revoked API token.
object
error
required
object
code
required
string
message
required
string
request_id
required
string
details
object
key
additional properties
any
Headers
Section titled “Headers ” X-Request-Id
string
Request identifier for troubleshooting.
Request was throttled.
object
error
required
object
code
required
string
message
required
string
request_id
required
string
details
object
key
additional properties
any
Headers
Section titled “Headers ” X-Request-Id
string
Request identifier for troubleshooting.
X-RateLimit-Limit
integer
Maximum requests allowed during current short window.
X-RateLimit-Remaining
integer
Remaining requests in current short window.
X-RateLimit-Reset
integer
Unix timestamp when short window resets.