Skip to content

Docs

API Documentation

English
Bahasa Indonesia
繁體中文

Initializing search

Learn More GET STARTED

Docs

Release Notes
Release Notes
- 2024
- 2023
- 2022
- 2021
- 2020
- 2019
Get Started
Product Introduction
Product Introduction
- Concepts
- Customer Value
Sign Up
Sign Up
- Commercial Plan Registration
  Commercial Plan Registration
  - Register Commercial Plan from the Official Website
  - Register Commercial Plan from Cloud Vendors
    Register Commercial Plan from Cloud Vendors
    
    Activate on Alibaba Cloud Marketplace
    
    Activate on Alibaba Cloud Overseas Marketplace
    
    Activate Exclusive Plan on Alibaba Cloud Marketplace
    
    Activate on AWS Marketplace
    
    Purchase on Huawei Cloud Store
    
    Purchase on Microsoft Azure Store
- Free Plan Registration
- Private Cloud Deployment Plan
Quick Start
Quick Start
- Dashboards
- Monitors
- APM
Billing Plans
Billing Plans
DataKit
DataKit
- Changelog
  Changelog
  - 2021~2024
- DataKit Installation
  DataKit Installation
  - Host Installation
  - Containers
    Containers
    
    Kubernetes
    
    Docker
    
    AWS ECS Fargate
  - Offline Installation
  - Batch Installation
- Using DataKit
  Using DataKit
  - Service Management
  - Status Management
  - Update
  - DQL Query
  - Other Commands
  - Trouble Shooting
    Trouble Shooting
    
    No data collected
    
    Bug report
    
    Datakit Metrics
  - Virtual Internet Access
    Virtual Internet Access
    
    Alibaba Cloud
    
    AWS Cloud
  - Performance
- DataKit Configuration
  DataKit Configuration
  - Major Configuration
  - Collector Configuration
  - Election Configuration
  - Proxy Configuration
  - Operator Configuration
  - Other Configurations
    Other Configurations
    
    Configuration Overview
    
    DCA
    
    Git
    
    Configuration Support
- DataKit Development
  DataKit Development
  - HTTP API
  - Documentation
Integrations
Platform Advantages
Core Components
Core Components
- Explorer
  Explorer
  - Search
  - Filter
  - Time Widget
  - Analysis
  - Columns
- Snapshot
  Snapshot
  - Save Snapshot
  - Share Snapshot
Pipelines
Pipelines
- Manage Pipelines
- Pipeline Manual
  Pipeline Manual
  - Quick start
  - Basics and principles
    
    Basics and principles
    
    Data processing of each data category
    
    Grok pattern
  - Platypus Grammar
  - Built-in function
  - Additional features
    Additional features
    
    Reference Table
    
    Offload
  - Performance benchmarks and optimizations
Key Capabilities
Scenarios
Scenarios
- Dashboards
  Dashboards
- Visual Charts
  Visual Charts
  - Chart Types
    Chart Types
    
    Time Series
    
    Bar Chart
    
    Pie Chart
    
    Overview Chart
    
    Top List
    
    Table Chart
    
    China Map
    
    World Map
    
    Scatter Plot
    
    Bubble Chart
    
    Histogram
    
    Treemap
    
    Cellular Map
    
    Heatmap
    
    Topology Map
    
    SLO
    
    Dashboard
    
    Funnel Chart
    
    Sankey Diagram
    
    Log Stream
    
    Object List
    
    Alert Statistics
    
    Monitor Summary
    
    Text
    
    Video
    
    Picture
    
    Command Panel
    
    IFrame
  - Chart Configuration
  - Chart Queries
    
    Chart Queries
    
    Simple Query
    
    Expression Query
    
    DQL Query
    
    PromQL Query
    
    Data Source Query
  - Chart JSON
  - Chart Links
    
    Chart Links
    
    Default Link
    
    Custom Link
    
    Use Case Examples
  - Event Association
- View Variables
  View Variables
  - Variable Query
  - Object Mapping
- Scheduled Reports
- Notes
- Explorer
  Explorer
- Built-in Views
  Built-in Views
  - Bind Built-in View
- FAQs
Metrics
Metrics
Logs
Logs
- LOG Collection
- Browser LOG Collection
- Mini App LOG Collection
- LOG Explorer
  LOG Explorer
  - LOG List
  - LOG Details
- BPF Network LOG
- Error Tracing
- Indexes
  Indexes
  - Log Indices
  - Direct Write Indices
  - External Indices
    External Indices
    
    SLS Logstore
    
    Elasticsearch
    
    OpenSearch
    
    LogEase
    
    Volcengine TLS
- Cross Workspace Index Query
- Frequently Asked Questions
Monitoring
Monitoring
- Monitors
  Monitors
- Intelligent Monitoring
  Intelligent Monitoring
- SLO
  SLO
- Mute Management
- Alert Strategies
  Alert Strategies
- Notification Targets
  Notification Targets
- FAQ
Incident
Incident
- Create Issue
- Manage Issue
- Analysis Board
- Calendar
- Configuration Management
  Configuration Management
Infrastructure
Infrastructure
- Data
- HOST
- CONTAINERS
  CONTAINERS
  - Type
    
    Type
    
    Containers
    
    Kubernetes
    
    Kubernetes
    
    Pods
    
    Services
    
    Deployments
    
    Nodes
    
    Replica Sets
    
    Jobs
    
    Cron Jobs
    
    Daemonset
    
    Statefulset
    
    Persistent Volumes
    
    PVC
  - Analysis Dashboard
- Process
- DATABASE
- NETWORK
  NETWORK
- Resource Catalog
  Resource Catalog
  - Data Reporting
Application Performance Monitoring
Application Performance Monitoring
- Data Collection
  Data Collection
- Service Management
  Service Management
- Overview
- Explorer
  Explorer
  - Manual Installation
    Manual Installation
    
    Deploy on Host
    
    Deploy on Kubernetes
  - Auto Injection
    Auto Injection
    
    Deployment on Host
    
    Deployment on Kubernetes
    Deployment on Kubernetes
    
    Install Datakit Operator
    
    Install Helm
  - Explorers
    
    Explorers
    
    List
    
    Detail Page
- Error Tracking
- Profiling
- FAQ
Real User Monitoring
Real User Monitoring
- Web
  Web
  - Changelog
  - App Data Collection
  - Custom View
  - Custom RUM SDK Data Collection
    
    Custom RUM SDK Data Collection
    
    Custom User Identifier
    
    Custom Addition of Extra Data TAGs
    
    Custom Addition of Actions
    
    Custom Addition of Errors
  - How to Configure RUM Sampling
  - Action
  - FAQ
- Miniapp
  Miniapp
  - Change Log
  - App Integration
  - Integration of Mini Programs Based on Uniapp Development Framework
  - Application Data Collection
  - Custom RUM SDK Data Collection Content
    
    Custom RUM SDK Data Collection Content
    
    Custom User Identifier
    
    Custom Addition of Extra Data TAG
    
    Custom Addition of Action
    
    Custom Addition of Error
- Android
  Android
- iOS/tvOS
  iOS/tvOS
- React Native
  React Native
- Flutter
  Flutter
- UniApp
  UniApp
- macOS
  macOS
  - App Access
  - App Data Collection
- C++
  C++
  - App Access
  - App Data Collection
- Unity
  Unity
  - App Access
- Explorers
  Explorers
  - Session
  - View
  - Resource
  - Action
  - Long Task
  - Error
- Application Analysis
- SESSION REPLAY
  SESSION REPLAY
  - Web
    
    Web
    
    How to Integrate Session Replay
    
    Troubleshooting
  - Mobile
    
    Mobile
    
    Android Session Replay
    
    iOS Session Replay
    
    React Native Session Replay
- User Analyses
  User Analyses
  - Session Heatmaps
  - Funnel Analysis
- RUM Data Access
- Self-tracking
- SourceMap
  SourceMap
Synthetic Tests
Synthetic Tests
- Test
  Test
  - Synthetic Tests
    
    Synthetic Tests
    
    HTTP
    
    ICMP
    
    TCP
    
    WEBSOCKET
  - Multi-step Test
- Overview
- Explorer
- User-defined Node Management
- FAQ
Event Center
Event Center
CI Visibility
CI Visibility
Cloud Billing Analysis
Data Compliance
Real Scenarios
Real Scenarios
Security Event Management
Security Event Management
- Create Detection Rules
  Create Detection Rules
  - Official Detection Library
  - Custom Creation
  - Arbiter
    
    Arbiter
    
    Syntax
    
    Built-in Functions
- Manage Detection Rules
- Signals
- Execution Logs
Security Check
Security Check
Sensitive Data Scanning
Sensitive Data Scanning
- Create Scanning Rules
  Create Scanning Rules
  - Custom Create
  - Official Rules Library
- Manage Scanning Rules
Open Capabilities
DataFlux Func
DataFlux Func
- DataFlux Func (Automata)
- Cloud Account Management
  Cloud Account Management
- External Data Sources
  External Data Sources
  - General Chart Data Returns
    General Chart Data Returns
    
    Line Chart
    
    Pie Chart
    
    Table Chart
  - Topology Map Data Returns
- Script Market
  Script Market
  - Basics
  - Cloud Synchronization Scripts
    Cloud Synchronization Scripts
    
    How to Enable
    
    Script List
    Script List
    
    Alibaba Cloud
    Alibaba Cloud
    
    Cloud Monitor (Metrics)
    
    AWS
    AWS
    
    Multiple Authentication Methods for AWS Client
    
    CloudWatch (Metrics)
    
    Huawei Cloud
    Huawei Cloud
    
    Cloud Monitor (Metrics)
    
    Tencent Cloud
    Tencent Cloud
    
    Cloud Monitor (Metrics)
    
    Azure
    Azure
    
    Azure Client Authorization
    
    Azure Monitor (Metrics)
    
    Volcengine
    Volcengine
    
    Cloud Monitor (Metrics)
    
    Google Cloud
    Google Cloud
    
    GCP Client Authorization
    
    Cloud Monitor (Metrics)
    
    FAQs
    FAQs
    
    Adding Extra Tags to Cloud Resource Data
    
    Notes
DQL
DQL
- DQL Query
- DQL Definition
- DQL Functions
- DQL Outer Functions
- DQL VS Other Query Languages
  DQL VS Other Query Languages
  - PromQL Quick Start
- Advanced Functions
  Advanced Functions
  - DBSCAN
  - How to Report Custom Advanced Functions with Local Func
- Rollup Functions
DCA
Custom Development
Custom Development
- Develop Custom Collector with Python
- Custom Scheck
  Custom Scheck
  - Implement Check for Changes in Sensitive Files
  - Monitor System User Changes
- Resource Catalog
OpenAPI
OpenAPI
- Public Request Parameters
- Public Response Structure
- Signature Authentication
- Usage Limitations
- Request Example
- Public Error Definitions
- Use Cases - Dashboard
  Use Cases - Dashboard
- Use Cases - Notes
  Use Cases - Notes
  - List
  - Get
  - Delete
  - Export
  - Import
  - Create
  - Modify
- Use Cases - Explorers
  Use Cases - Explorers
  - List
  - Get
  - Delete
  - Export
  - Create
  - Modify
  - Import
- Use Cases - Built-in Views
  Use Cases - Built-in Views
- Use Cases - Service Management
  Use Cases - Service Management
- Events
  Events
- Incident - Channels
  Incident - Channels
  - List
  - Create
  - Modify
  - Delete
  - Subscribe
- Incident - Issues
  Incident - Issues
- Incident - Schedules
  Incident - Schedules
  - List
  - Get
  - Create
  - Modify
  - Delete
- Incident - Configuration Management - Notification Policies
  Incident - Configuration Management - Notification Policies
  - List
  - Get
  - Add
  - Modify
  - Delete
- Incident - Configuration Management - Issue Discovery
  Incident - Configuration Management - Issue Discovery
- Infrastructure
  Infrastructure
  - Get all labels
  - Modify host labels
- Infrastructure - Resource Catalogs
  Infrastructure - Resource Catalogs
- LOG - Pattern Queries
  LOG - Pattern Queries
  - Get query task results
  - Send a query task
- LOG - Indexes
  LOG - Indexes
- LOG - Data Forwarding
  LOG - Data Forwarding
  - List
  - Get
  - Create
  - Modify
  - Delete
- LOG - Data Access
  LOG - Data Access
  - List
  - Get
  - Create
  - Modify
  - Enable/Disable
  - Delete
- Metrics - Retrieve Measurement Information
  Metrics - Retrieve Measurement Information
  - 【Measurement】Metrics and Labels Information Acquisition
- Metrics - Aggregate to Generate Metrics
  Metrics - Aggregate to Generate Metrics
  - List
  - Create
  - Get
  - Modify
  - Disable/Enable
  - Delete
- RUM PV - Applications
  RUM PV - Applications
- RUM PV - SourceMaps
  RUM PV - SourceMaps
- Synthetic Tests - Testing Tasks
  Synthetic Tests - Testing Tasks
- Synthetic Tests - Self-built Nodes Management
  Synthetic Tests - Self-built Nodes Management
  - List
  - Get
  - Delete
  - Create
- Monitoring - Checkers
  Monitoring - Checkers
- Monitoring - SLO
  Monitoring - SLO
  - Create
  - Get
  - List
  - Modify
  - Delete
  - Batch Delete
  - Disable/Enable
  - Batch Disable/Enable
- Monitoring - Intelligent Inspections
  Monitoring - Intelligent Inspections
  - List
  - Get
  - Create
  - Modify
  - Disable
  - Enable
  - Delete
  - Batch Delete
- Monitoring - Mute Configurations
  Monitoring - Mute Configurations
  - List
  - Create
  - Modify
  - Disable
  - Enable
  - Delete
- Monitoring - Alert Strategies
  Monitoring - Alert Strategies
  - List
  - Create
  - Create v2
  - Get
  - Modify
  - Modify v2
  - Delete
- Monitoring - Alert Strategies - Custom Notification Dates
  Monitoring - Alert Strategies - Custom Notification Dates
  - List
  - Create
  - Get
  - Modify
  - Delete
- Monitoring - Notification Targets
  Monitoring - Notification Targets
  - List
  - Create
  - Get
  - Modify
  - Delete
  - Batch Delete
- Management - Field Management
  Management - Field Management
  - List
  - Get
  - Add
  - Modify
  - Delete
- Management - Global Tags
  Management - Global Tags
  - List
  - Get
  - Create
  - Modify
  - Delete
- Management - Member Management
  Management - Member Management
- Management - Member Management - Role Permissions
  Management - Member Management - Role Permissions
  - List permission information
- Management - Member Management - Team Management
  Management - Member Management - Team Management
  - List
  - Get
  - Delete
  - Create
  - Modify
- Management - Member Management - SSO Management
  Management - Member Management - SSO Management
- Management - Member Management - SSO Management - Custom Mapping Rules (Deployment Plan)
  Management - Member Management - SSO Management - Custom Mapping Rules (Deployment Plan)
- Management - Role Management
  Management - Role Management
  - List
  - Get
  - Create
  - Modify
  - Delete
- Management - API Key Management
  Management - API Key Management
  - List
  - Get
  - Delete
  - Create
- Management - Blacklists
  Management - Blacklists
  - List
  - Get
  - Create
  - Modify
  - Delete
  - Import
  - Export
- Management - Pipelines
  Management - Pipelines
  - List
  - Create
  - Get
  - Modify
  - Delete
  - Enable/Disable
  - Import
  - Export
- Management - Data Access
  Management - Data Access
  - List
  - Get
  - Create
  - Modify
  - Delete
  - Disable/Enable
- Management - Sensitive Data Masking
  Management - Sensitive Data Masking
  - List
  - Get
  - Create
  - Modify
  - Enable/Disable
  - Delete
- Workspaces
  Workspaces
- Workspaces - Attribute Claims
  Workspaces - Attribute Claims
  - Get
  - Modify
- Snapshot Management
  Snapshot Management
- DQL Data Query
  DQL Data Query
- Func Functions
  Func Functions
  - List
  - Execute external functions
- Billing Analysis
  Billing Analysis
- Login-Free Tokens
  Login-Free Tokens
  - Generate token
  - Revoke token
- Chart Images
  Chart Images
  - Get time series trend chart
API Documentation
API Documentation
Unified Entry
Management
Management
- User Settings
- Workspace Management
  Workspace Management
  - Key Metrics
  - Customized Menu
- Attribute Claims
- Field Management
- Global Label
- Environment Variables
- Member Management
  Member Management
  - Invite Members
- Role Management
  Role Management
  - Permission List
- API Key Management
  API Key Management
  - OpenAPI
- Client Token Management
- Blacklist
- Data Forwarding
  Data Forwarding
  - Create Forwarding Rules
    
    Create Forwarding Rules
    
    Forward Data to AWS S3
    
    Forward Data to Huawei Cloud OBS
    
    Forward Data to Alibaba Cloud OSS
    
    Forward Data to Kafka Message Queue
  - Manage Forwarding Rules
- Data Access
- Regular Expressions
- Audit Events
- Share Management
- Cross-Workspace Authorization
- Sensitive Data Masking
- SSO Management
  SSO Management
  - SAML
    
    SAML
    
    Configuration examples
    Configuration examples
    
    Alibaba Cloud IDaaS
    
    Authing
    
    Azure AD
    
    IAM Identity Center
    
    Okta
    
    Keycloak
  - OIDC
  - Role mapping
  - Frequently asked questions
- MFA Management
- Support Center
  Support Center
- FAQ
Billing Plans and Invoices
Billing Plans and Invoices
- Billing
  Billing
- FAQ
  FAQ
  - Registration and Plans
  - Settlement and Billing
Billing Center
Billing Center
Private Deployment
ExternalAPI
ExternalAPI
- Public Request Parameters
- Public Response Structure
- Signature Authentication
- Front Accounts
  Front Accounts
  - List
  - Get
  - Create
  - Modify
  - Enable/Disable
  - Delete
  - Change brand identifier
- Backend Management Accounts
  Backend Management Accounts
  - List
  - Create
  - Get
  - Modify
  - Enable/Disable
  - Delete
- Workspace Members
  Workspace Members
- Workspace
  Workspace
- Workspace API Key
  Workspace API Key
  - Create
  - Obtain
  - Modify
  - List
  - Delete
  - Batch Delete
- Role Management
  Role Management
  - List
- Group Management
  Group Management
  - List
  - Create
  - Modify
  - Manage workspaces
  - Delete
- Data Queries
  Data Queries
  - DQL Data Query
- Login Mapping Rules
  Login Mapping Rules
- Scenes-Dashboards
  Scenes-Dashboards
  - Identifier Import
- APM
  APM
  - APM services list
  - Service Map
- DataKit List
  DataKit List
  - Online Datakit List
Others
Third-Party Integration
Related Agreements
Related Agreements

Overview¶

This section includes some public descriptions in TrueWatch Open API / External API.

2025-08-26 2025-08-26

Stay Connected

Contact Us

Copyright © 2025 TrueWatch all rights reserved.