Report Creation API Overview

The /reports/create endpoint provides essential functionalities for generating detailed reports based on your data. This section of the API documentation covers the capabilities to monitor ongoing report generation, and initiate new reports tailored to specific requirements.

API Capabilities

The Report Creation API enables you to:

• Determine Available Data: Identify the time periods and countries available for reporting, based on both uploaded and live data.
• Monitor Report Progress: Check the status of ongoing report generation, ensuring that your data processing is proceeding as expected.
• Generate Custom Reports: Create tailored reports by specifying time frames, countries, and data categories.

Endpoint Descriptions

• Determining Data Availability

  GET {baseURL}/country_times: Retrieves the minimum and maximum times available and a list of countries for which data is available. This functionality is crucial for setting appropriate parameters for report generation.

• Monitoring Report Generation

  GET {baseURL}/get_report_progress: Provides real-time status updates on whether a report is currently being generated, helping you manage report scheduling and availability.

• Creating Custom Reports

  POST {baseURL}/create_report_user: Allows for the creation of a customized report based on specified parameters. This endpoint caters to flexibility by allowing the reuse of existing report IDs or setting new criteria.

Managing Report Requests

To ensure effective report generation:

• Accurate Data Specification: Verify that all parameters such as country codes, date ranges, and categories are correctly specified to avoid errors in the report.
• Ongoing Monitoring: Regularly check the progress of report generation, especially for large datasets, to manage resource allocation and timing effectively.

Importance of Timely and Accurate Reporting

Accurate and timely reporting is critical for compliance, decision-making, and strategic planning. The ability to generate customized reports based on specific data slices allows organizations to gain insights that are precise and relevant to their operational needs.

Conclusion

Utilizing the Report Creation API effectively empowers your business to generate precise and actionable reports based on comprehensive data analysis. By leveraging the functionalities outlined in this section, you can ensure that your reporting processes are both efficient and aligned with your business objectives.