TSAPI Documentation
TSAPI is the API Standard for Transferring Survey Data. A non-profit initiative to define, distribute, and maintain an API standard for the survey industry.
Free & Open Standard
All material is licensed under the Creative Commons Attribution 4.0 International License. It is, and always will be, free to all, forever.
What is TSAPI?
An application programming interface (API) is a way for two or more computer programs to communicate with each other. TSAPI provides a standardized way to transfer survey data between different platforms and systems.
Core Objectives
- Positioning: Help preserve & develop survey data's position in the knowledge economy
- Connectivity: Improve connectivity & interoperability between survey platforms
- Innovation: Facilitate innovation by removing barriers to data transfer
- Integration: Ease the connection of MR insights to other industries & sectors
“The freedom to move data into a processing platform of choice is something that unlocks the power of survey data and will drive innovation in tools supporting survey data sets.”
The Problem TSAPI Solves
Without a common standard, each survey platform has its own API definition for transferring data. When Platform A needs to communicate with Platform B, developers must build custom converters. These converters:
- Take time and money to develop
- Are prone to errors and need constant maintenance
- May break when either platform updates their definition
- Don't scale as the number of platforms increases
With 14 platforms, you'd need 91 converters (or 182 for two-way data flow). TSAPI eliminates this complexity by providing a single, agreed-upon standard that all platforms can implement.
TSAPI Format
The TSAPI Standard represents survey data and survey metadata in JSON (JavaScript Object Notation) - an open standard data interchange format that uses human-readable text to store and transmit data.
The structure aligns with the accepted norms of the wider software development community and draws on many decades of survey data implementation and execution.
Quick Links
Getting Started
Learn how to make your first TSAPI request
API Reference
Complete documentation of all TSAPI endpoints
Data Types
Understanding variable types in survey data
FAQ
Common questions about TSAPI
The TSAPI Steering Group
The TSAPI Steering Group are all volunteers who guide the initiative with the support of other interested organisations and individuals. The development has involved years of work, primarily by Matt Gibbs (Chair), Tim Brandwood (Lead Programmer), and Jérome Sopoçko (Software Coordinator).
Endorsements
TSAPI has been endorsed by the Association for Survey Computing (ASC), the world's leading community for anyone who works with surveys, survey data, and insights.
“ASC endorses TSAPI as an industry standard for survey data transfer and interoperability between different survey and data platforms.”
License
All TSAPI material is licensed under the Creative Commons Attribution 4.0 International License. You are free to use, share, and adapt the standard, with appropriate credit to the TSAPI Initiative.