Skip to content
Last updated

How to Read This Documentation

This page explains how the Treasure Data documentation portal is organized and how to find the information you need. Whether you are a marketer, data engineer, IT admin, or AI Agent, this guide helps you get the most out of these docs.

Documentation Structure

The left sidebar is the primary way to browse documentation. It is organized into the following major sections:

SectionWhat It Contains
Getting StartedRole-based guides for Marketers, Data Engineers, IT Admins, and AI Agents
Treasure CodeCLI tools (tdx) and AI-assisted development guides
ProductsDetailed documentation for all Treasure Data products
IntegrationsConnectors for data sources and destinations
ToolsDeveloper tools and utilities
SupportHow to contact support and troubleshooting resources
API DocumentsREST API references and client libraries
Requirements and LimitationsSystem requirements and known limitations
Release NotesMonthly product updates organized by year
Security & TrustSecurity policies and compliance information

Sidebar groups are expandable and collapsible. Click a group name to expand it and see its child pages. Products are organized hierarchically. For example, to find Audience Studio documentation, navigate to Products > Customer Data Platform > Audience Studio.

Top Navigation Bar

The top navigation bar provides quick access to:

  • Support - Links to the support resources page
  • Release Note - Jump directly to the latest release notes
  • API Docs - Link to the external API documentation site
  • Search - Full-text search across all documentation (see Using Search below)
  • Languages - Switch the documentation language between English and Japanese (see Switching Languages below)

At the top of each page, breadcrumbs show your current location in the documentation hierarchy. Click any breadcrumb to navigate to that level. For example:

Home > Products > Customer Data Platform > Data Workbench

On-Page Table of Contents

On the right side of each page, a table of contents is automatically generated from the page headings (up to 3 levels deep). Click any heading to jump directly to that section.

Click the search bar in the top navigation or use the keyboard shortcut to open the search dialog. Search supports:

  • Full-text search across all documentation pages
  • Faceted filters to narrow results by:
    • Category - Products, Guides, Integrations, Release Notes, etc.
    • Product - Filter by specific product name (for example, Data Workbench, Audience Studio)
    • Release Year - Filter release notes by year

Ask AI

An AI assistant is available at the bottom-center corner of every page. Click the Ask AI button to ask natural-language questions about Treasure Data products and features. The assistant searches the documentation and provides answers with links to relevant pages.

You can also access the AI assistant through the search dialog.

API Documentation

Treasure Data provides REST APIs for programmatic access.

API references available in this portal:

APIDescription
TD API v3Core platform API for databases, tables, queries, and jobs
Postback APIImport small JSON payloads (used by JavaScript and Mobile SDKs)
Audience APICDP-specific APIs for segments, journeys, and audiences
DWH Integration APIData warehouse integration endpoints

Each API reference includes interactive endpoint exploration where you can view parameters, request/response schemas, and example payloads.

Switching Languages

This documentation is available in English (default) and Japanese.

To switch the document language:

  1. In the top-right corner of the screen, click the globe icon.
  2. From the drop-down list, select a language.
  • If a Japanese translation is not yet available for a page, the portal falls back to the English version.

Release Notes

Release notes are published monthly and organized by year in the sidebar under Release Notes. Each release note covers new features, improvements, and fixes across all Treasure Data products.

To find release notes for a specific period, use the search feature with the Release Year filter.

Getting Help

If you need further assistance: