Skip to main content

Guides

The guides explain how to use the TOM External API to solve tasks. The API reference describes every operation, parameter and schema; the guides tell you which operations to combine, in which order and why.

Get started​

Concepts​

  • Core concepts: surveys, variables, carriers, statistics, workspaces, targets, tables, plans and jobs, and the identifiers that connect them.
  • Limits and conventions: formats, sizes, timeouts, limits, idempotency and what to retry.

Task guides​

Reference​

Migration and changes​

How the API reference is organized​

The API reference groups the operations in these sections. Each one has a guide.

Section of the referenceGuide
StatisticsBuilding tables, Core concepts
SurveysGetting started
WorkspacesWorkspaces, targets and reusable elements
Variables and carriersExploring variables and carriers
Saved tabulationsBuilding tables
User variables, TargetsWorkspaces, targets and reusable elements, TGL guide
Table calculationBuilding tables
Ranking, Evaluation, Response curveMedia planning
ReachReach and duplication tables
OptimizationAsynchronous optimization