Logo
Login

Reports API

The Reports API is a powerful tool that provides you with complete transparency over your communication activities. Whether for billing purposes, business analytics, or optimizing your communication processes – with the Reports API, you have all relevant data available at any time and can analyze it flexibly according to your needs. The combination of two different retrieval methods ensures that you are optimally equipped for both quick individual queries and comprehensive data analyses.

Benefits of the Reports API

/uploads/C_Paa_S_7c8405c9c9_1fbd6fbd82.svg

Comprehensive Overview of All Communication Channels

With a single interface, you gain access to data from various communication channels: - SMS and MMS - WhatsApp, Viber, Instagram, and Messenger - Telephony (traditional calls and internet telephony) - Video conferencing - Verification services - and more
/uploads/news_icon_18_27640312aa_e69e8464d6.svg

Flexible Data Retrieval Options

The Reports API offers two different retrieval methods that you can choose based on your needs: Synchronous Retrieval – for quick access to smaller data volumes: - Immediate results - Ideal for regular queries - Retrieval of single records up to several thousand records - Ability to search for individual messages or calls by their ID Asynchronous Retrieval – for large data volumes: - Optimized for extensive analyses - Processing of thousands to millions of records - Results provided as a compressed file - Automatic notification when data is available

Extensive Filtering Options

You can filter your data by various criteria:

  • Time periods (up to 13 months back)
  • Phone numbers (sender and recipient)
  • Communication direction (inbound or outbound)
  • Message status (delivered, failed, rejected, etc.)
  • Subaccounts
  • Specific message content

Data Retention

Your communication data is stored for 13 months by default (90 days for Video API). Older data is automatically deleted.

How data retrieval works

Synchronous Retrieval (for smaller data volumes) 1. You send a request with your desired filter criteria 2. The API immediately delivers up to 1,000 records in JSON format 3. If more data is available, you receive a link to the next page 4. You can retrieve individual messages by their unique ID

Asynchronous Retrieval (for large data volumes) 1. You create a data request with your filter criteria 2. The API registers your request and begins processing 3. The data is compiled into a compressed CSV file 4. Optional: You receive an automatic notification when the file is ready 5. You download the file within 72 hours (after which it is automatically deleted)

Performance Note: The asynchronous API processes an average of 1 million records in 5 to 10 minutes. For optimal results, it is recommended to limit queries to a maximum of 7 million records.

Supported products and services

The Reports API works with a variety of communication services:

  • Text messages (SMS, MMS, RCS)
  • Instant messaging (WhatsApp, Viber, Instagram, Facebook Messenger)
  • Telephony (traditional and internet-based calls)
  • Speech recognition and speech synthesis
  • Video conferencing
  • Two-factor authentication
  • Phone number information services
  • Network APIs (e.g., SIM swap detection)

Learn more about our APIs

Interested in how our APIs can help your business? Connect with a Deutsche Telekom API expert: fill out the form and we'll get back to you shortly..