ATRS REST API Overview
Connect your application to ATRS, find Tableau content, run reports and check their results.
Use the ATRS REST API to connect your application to your ATRS installation. Discover Tableau content, manage report schedules, run reports and check their results.
These guides cover the latest version of ATRS. Find the latest release information and download ATRS from the ChristianSteven website.
How the API works
Your application sends requests to the API service running on your ATRS server. ATRS uses its configured Tableau accounts to access reports, generate output and deliver it to the selected destinations.
The API works with the resources and permissions configured in your ATRS environment. Confirm that a report runs successfully in ATRS before adding it to your integration.
What you can do
| Task | Use the API to |
|---|---|
| Find reports and schedules | Browse Tableau accounts, projects, workbooks and views, or locate schedules in ATRS folders. |
| Manage single-report schedules | Create a schedule from a working template, change its settings and control recurring delivery. |
| Configure report output | Choose parameters, rendering settings and email or disk destinations. |
| Create report packages | Combine Tableau reports, recurrence and destinations in a package. |
| Build data-driven packages | Map input records to Tableau report parameters and deliver the resulting reports. |
| Run reports | Submit an existing report schedule or package and save its execution identifier. |
| Monitor your workflow | Check results, inspect current work and investigate interrupted requests. |
Before you begin
You need:
- A running ATRS API service.
- The service’s protocol, hostname and port.
- Network access from your application to the ATRS server.
- An ATRS user account or API client with the required access.
- A working report schedule and a test destination for your first execution.
Start with Install and Configure the ATRS API if the service is not yet available.
Connect to your ATRS installation
Build the base address from your installation’s settings, for example https://atrs.example.com:9001. Append the complete endpoint path shown in the API Reference.
To check connectivity, call GET /api/Service/Ping. A successful response contains the JSON number 1.
Keep /api out of the base address and do not add a /v1 path. Your requests go to your ATRS server; the documentation website hosts these guides. Use localhost only when the request runs on the ATRS server itself.
Use a trusted HTTPS connection when sending credentials across a network. Follow Configure HTTPS for the ATRS API to set it up and verify it.
Authenticate your application
Choose the credentials your application will use:
| Credentials | Token request | Token in the response |
|---|---|---|
| API client ID and secret | POST /api/OAuth2/token | access_token |
| ATRS user credentials | POST /api/Login/token | token |
Send the returned token in the Authorization header with the Bearer prefix. Authentication and Token Management provides complete examples and expiration handling.
Run your first schedule
- Choose a schedule that already runs successfully in ATRS.
- Confirm its identifier, schedule family and test destination.
- Submit the execution and save the returned
ExecutionId. - Use that identifier to monitor the execution.
- Check the execution result, then open the report and verify its destination.
An accepted request confirms submission. A completed execution still needs its result checked. Follow a successful result with the content and delivery checks your workflow requires.
Quick Start: Execute and Monitor a Schedule takes you through this workflow.
Use the API Reference
Each reference operation shows its method, path, request fields and responses. Use the schema for the operation you are calling: a saved schedule response, a full update request and an exported definition serve different purposes.
Some listing operations use GET requests with JSON bodies. Use a client that supports the documented request format, or a POST alternative where the reference provides one.
Where to go next
- Use the ATRS API with Postman to try requests interactively.
- Discover Folders and Tableau Resources to select your content.
- Create a Schedule from a Working Template to create and edit a single-report schedule.
- Create and Manage Report Packages to combine reports in a package.
- Create a Data-Driven Tableau Package to generate reports for input records.
- Schedule Lifecycle Reference to choose a schedule action.
- Monitor, Recover, and Reconcile Executions to handle timeouts and uncertain results.
Updated about 8 hours ago