Skip to main content

Is it possible to use the REST API to run and retrieve a report from SysAid? 

Hi there,

SysAid Copilot is here with our AI Magic!

Here is the response we thought might assist you:

## Using REST API to Retrieve Reports in SysAid

Currently, SysAid's REST API does not directly support running and retrieving reports. However, you can use the REST API to extract data from SysAid, which can then be used to create custom reports in external tools like Power BI or Excel. Here's how you can proceed:

### Steps to Extract Data via REST API

1. **Authenticate with the API**:
- Use the login endpoint to authenticate and obtain a session ID (`jsessionID`) or API key.
- Example endpoint: `https://your-sysaid-url/api/v1/login`.

2. **Identify the Data You Need**:
- Determine the specific data you want to include in your report (e.g., service records, assets, users).
- Use the appropriate API endpoints to retrieve this data. For example:
- Service Records: `/api/v1/sr`
- Assets: `/api/v1/assets`

3. **Filter and Customize Data**:
- Use query parameters to filter and customize the data you retrieve. For example:
```
GET https://your-sysaid-url/api/v1/sr?fields=id,description,status&status=Open
```

4. **Export Data**:
- Once you retrieve the data, export it to a format suitable for your reporting tool (e.g., JSON, CSV).

5. **Create Reports in External Tools**:
- Import the exported data into tools like Power BI, Excel, or any other reporting software to generate the desired reports.

### Alternative: Use SysAid's Built-in Reporting

If you need to generate reports directly within SysAid, you can use the built-in reporting feature. Follow these steps:
1. Log in to the SysAid Admin Portal.
2. Navigate to the **Analytics - Reports** section.
3. Create or customize a report.
4. Run the report and export it in formats like CSV, Excel, or PDF.

### Additional Notes
- If you need to automate report generation and retrieval, consider scheduling reports in SysAid to be sent via email.
- For more advanced integrations, you can combine SysAid's API with custom scripts to automate data extraction and reporting.

For further details, refer to the [SysAid REST API Documentation](https://documentation.sysaid.com/docs/rest-api-details). If you have specific requirements or encounter challenges, feel free to ask for additional guidance!

Hi ​@rdtjbrown,

Could you please let us know if Copilot’s answer solved your query?

If you need more help, have further questions, or just want to chat about this topic, please don't hesitate to reach out.


Reply