Export Report Data via Maxio API

Maxio provides a comprehensive API for running reports and exporting their data programmatically. Use it to automate recurring report pulls, sync report data into your own systems, or build custom integrations, instead of relying on the Maxio user interface to run and download reports manually.

The Reports API allows you to:

• Execute predefined reports or one-click reports.
• Monitor report execution status.
• Export report results in multiple formats.
• Retrieve exported files for download.

API endpoints overview

The Reports API uses the following base endpoints:

• Report Definitions: /{your-instance}/api/v1.0/reports/definitions/
• Report Runs: /{your-instance}/api/v1.0/reports/runs/
• Report Exports: /{your-instance}/api/v1.0/reports/exports/

Replace {your-instance} with your specific Maxio instance identifier. You can find this in your account settings or by checking the URL when logged into your Maxio dashboard.

Authentication

All API requests require proper authentication. Refer to the main API documentation for details on authentication methods and required headers. For complete API reference documentation, including all available parameters and response schemas, consult the OpenAPI documentation available in your Maxio instance.

Working with report definitions

Before running reports, you may want to explore what reports are available in your account. Report Definitions are read-only through this API. You can list and retrieve them, but creating, editing, or deleting a report definition requires the Maxio user interface.

Listing available reports

GET /{your-instance}/api/v1.0/reports/definitions/

Available Filters:

• name=Revenue - Filter by report name (partial match).
• description=monthly - Filter by description (partial match).
• type=financial - Filter by report type.
• tag=important - Filter by applied tags.
• one_click_report_group=uuid - Filter by one-click report group.
• created_by=123 - Filter by user who created the report.
• modified__gte=2025-01-01T00:00:00.000000 - Filter by modification date.

Sorting Options:

• id, name, description, type, created_by, one_click_report_group, modified

Getting report details

GET /{your-instance}/api/v1.0/reports/definitions/123/

This returns the complete structure of a specific report definition, including its configuration and parameters.

Basic workflow

Step 1: Run a report

To execute a report, make a POST request to /{your-instance}/api/v1.0/reports/runs/ with one of the following approaches:

Option A: Using a Report Definition ID

POST /{your-instance}/api/v1.0/reports/runs/
{
  "report_definition": 123,
  "export_format_name": "csv"
}

Option B: Using a One-Click Report UUID

POST /{your-instance}/api/v1.0/reports/runs/
{
  "one_click_report": "uuid-string-here",
  "export_format_name": "csv"
}

Available Export Formats:

• "csv" - Legacy CSV format
• "gsheets" - Legacy Google Sheets format
• "ucsv" - Unified CSV format
• "tgsheets" - Tabbed Google Sheets format
• "xlsx" - Excel format
• "xlsx1d" - OneDrive format

"ucsv" only works for reports built on the Generic Report Builder, such as Advanced Subscription Momentum, Finance Details by Transaction, and Days Sales Outstanding. Requesting it for any other report type fails.

The API response includes the run ID and URL for tracking progress:

{
  "id": "456",
  "url": "/api_path/reports/runs/456/"
}

Step 2: Monitor run status

Check the execution status by making a GET request to the run URL:

GET /{your-instance}/api/v1.0/reports/runs/456/

The response includes detailed status information:

{
  "id": 456,
  "status": "Completed",
  "duration_secs": "12.5",
  "timestamp": "2025-01-15T10:30:00Z",
  "user_full_name": "John Doe",
  "report_name": "Monthly Sales Report",
  "report_type": "sales_summary",
  "failure_message": null
}

Possible Status Values:

• "Running" - Report is currently executing.
• "Completed" - Report finished successfully.
• "Failed" - Report execution failed.

Wait until the status becomes "Completed" before proceeding to retrieve results.

Step 3: Retrieve report data

You have two options for accessing the report results:

Option A: Direct CSV Download (for smaller reports)

GET /{your-instance}/api/v1.0/reports/runs/456/?mode=csv

This streams the CSV data directly in the response. This method is ideal for smaller reports that can be processed immediately.

Option B: Create a Persistent Export (recommended for larger reports)

1. Create an export:

POST /{your-instance}/api/v1.0/reports/exports/
{
  "report_run": 456,
  "format_name": "csv"
}

2. Monitor the export status:

GET /{your-instance}/api/v1.0/reports/exports/789/

The response includes export details:

{
  "id": 789,
  "status": "Completed",
  "report_run": 456,
  "format_name": "csv",
  "timestamp": "2025-01-15T10:35:00Z",
  "url": "https://storage.example.com/exports/report_789.csv",
  "failure_message": null
}

Export Status Values:

• "Scheduled" - Export is queued for processing.
• "Running" - Export is being generated.
• "Completed" - Export is ready for download.
• "Failed" - Export generation failed.
• "Viewed" - Export has been accessed.

3. Once the export status is "Completed", retrieve the file:

GET /{your-instance}/api/v1.0/reports/exports/789/?redirect=1

The redirect=1 parameter redirects you directly to the downloadable file.

Managing reports and exports

Listing report runs

View all your report runs with optional filtering and sorting:

GET /{your-instance}/api/v1.0/reports/runs/

Available Filters:

• report_definition=123 - Filter by specific report definition ID.
• one_click_report=uuid - Filter by one-click report UUID.
• status=Completed - Filter by status (Running, Completed, Failed).
• user=456 - Filter by user ID who ran the report.
• report_name=Sales - Filter by report name (partial match).
• report_type=summary - Filter by report type.
• timestamp__gte=2025-01-01T00:00:00.000000 - Filter by date range (after).
• timestamp__lt=2025-02-01T00:00:00.000000 - Filter by date range (before).

Sorting Options:

Use the sort parameter with any of these fields:

• timestamp - Sort by execution time.
• duration_secs - Sort by execution duration.
• user - Sort by the ID of the user who ran the report.
• user_full_name - Sort by user name.
• report_name - Sort by report name.
• report_type - Sort by report type.
• data_format - Sort by data format.
• report_definition - Sort by report definition ID.
• status - Sort by status.

Example with filters:

GET /{your-instance}/api/v1.0/reports/runs/?status=Completed&report_type=sales&sort=timestamp

Listing exports

Similarly, you can list and filter exports:

GET /{your-instance}/api/v1.0/reports/exports/

Available Filters:

• report_run=456 - Filter by specific report run ID.
• report_definition=123 - Filter by report definition ID.
• status=Completed - Filter by export status.
• format_name=csv - Filter by export format.
• report_name=Monthly - Filter by report name (partial match).
• report_type=summary - Filter by report type.
• timestamp__gte=2025-01-01T00:00:00.000000 - Filter by date range.

Sorting Options:

• report_run, report_definition, timestamp, format_name, report_name, report_type, status

Example:

GET /{your-instance}/api/v1.0/reports/exports/?status=Completed&format_name=csv&sort=timestamp

Best practices

1. Choose the Right Approach: Use export_format_name when creating a report run to automatically trigger export creation, especially for larger datasets.
2. Don't Mix Report Types: Specify either report_definition or one_click_report when creating a run, but never both.
3. Poll Responsibly: When monitoring status, implement reasonable polling intervals (e.g., every 5-10 seconds) to avoid overwhelming the API.
4. Handle Large Reports: For reports that may generate large datasets, always use the persistent export approach rather than direct CSV streaming.
5. Use Filtering: Take advantage of the filtering parameters when listing runs and exports to find specific results quickly.
6. Date Format Consistency: When using datetime filters, always use the format YYYY-MM-DDTHH:MM:SS.000000 (e.g., 2025-01-15T14:30:00.000000).
7. Pagination: Use the page parameter for large result sets and check the next and previous URLs in responses for navigation.

Error handling

Common scenarios to handle in your implementation:

• Invalid Report IDs: Ensure your report definition IDs are valid and accessible.
• Long-Running Reports: Some reports may take several minutes to complete - implement appropriate timeout handling.
• Export Failures: Check export status and handle failed exports appropriately by examining the failure_message field.
• Rate Limiting: Implement proper retry logic with exponential backoff for API requests.
• Empty Results: Handle cases where reports complete successfully but contain no data.

Troubleshooting

Report run fails

• Check that the report definition ID exists and is accessible to your user.
• Verify that editable report definitions are being used (some reports may be read-only).
• Review the failure_message field in the response for specific error details.

Export never completes

• Monitor the export status regularly.
• Check system status if exports remain in "Running" state for extended periods.
• Contact support if exports consistently fail with specific report types.

Direct CSV download issues

• Use the mode=csv parameter only for smaller reports.
• Switch to persistent exports for large datasets.
• Ensure the report run status is "Completed" before attempting CSV download.

Related information

For an overview of exporting data from Maxio, including how to initiate an export from the user interface, see Understand Data Export.