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
- Getting started: from an API key to your first calculated table.
- Authentication and access: the API key, the licensed modules and survey access.
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
- Exploring variables and carriers: discover the codes you need.
- Building tables: axes, variables, statistics, planes, split axes and saved tabulations.
- Reach and duplication tables: Reach on consumption-diary surveys.
- Media planning: rank carriers, evaluate media plans and calculate response curves.
- Asynchronous optimization: submit, poll and read the result of a media plan optimization.
- Workspaces, targets and reusable elements: create workspaces, manage targets and reuse saved tables.
Reference
- Errors and troubleshooting: the error body, every error code and what to do about it.
- TGL guide: the expression language that defines audiences.
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 reference | Guide |
|---|---|
| Statistics | Building tables, Core concepts |
| Surveys | Getting started |
| Workspaces | Workspaces, targets and reusable elements |
| Variables and carriers | Exploring variables and carriers |
| Saved tabulations | Building tables |
| User variables, Targets | Workspaces, targets and reusable elements, TGL guide |
| Table calculation | Building tables |
| Ranking, Evaluation, Response curve | Media planning |
| Reach | Reach and duplication tables |
| Optimization | Asynchronous optimization |