Configuring and using the Global Report API

The Air Maestro Global Reporting module includes an API that enables external data systems, like Power BI, to retrieve report data through web requests.

Important: As of Air Maestro v3.6.22353.10648, support for API keys in URLs was deprecated due to security concerns. API keys should now be included in the request headers instead. Keys in the URL are not encrypted and may be exposed in logs or intercepted. While older URL-based API links still function, it is strongly recommended to transition to the secure header-based method.

Below are the key steps for enabling, accessing, and integrating Global Report data from Air Maestro using the API:

1. Enabling the API

2. Making Web Requests to the API

3. Connecting to the API Key with Authorization Header

4. Connecting to the API with Power BI

1. Enabling the API

To enable API access for a report:

1. Go to the Global Reporting > A Global Report's wizard > Step 5. Report Schedule
   
   
2. Click Add API Key to generate a new key and enable API access.
   
   
   
   
3. Update the expiry date of the new API key. By default, it’s set to the current UTC time.

• 1. Click the pencil icon to edit.
  2. Choose an appropriate future date.
  3. Click the tick to save.

2. Making Web Requests to the API

This section outlines how to structure your web requests and what options you can include.

2.1 URL Basics

After generating an API key, click Copy URL on the report schedule page.

This URL identifies the report endpoint. Paste it into your preferred tool (e.g. Postman, Power BI).

2.2 Data Format

The API supports the following output formats:

• CSV
• Excel (.xls)
• Excel07On (.xlsx)
• PDF
• Word (.doc)
• Word07On (.docx)
• JSON

The default format is CSV. To request a different format, append

?format=FORMAT 

to the URL.

Example:

https://subdomain.airmaestro.com.au/api/reports/123?format=JSON

2.3 Attachment Mode

By default, API requests return reports as downloadable attachments. To receive the data inline (which is useful for tools like Power BI), append this to the URL:

&AsAttachment=False

Example:

https://subdomain.airmaestro.com.au/api/reports/123?format=JSON&AsAttachment=False

2.4 Filter Values

If your report includes filters, you can pass those values via query string parameters.

Filter parameter names and formatting details appear below the API key table on the Report Schedule page.

Example:

https://subdomain.airmaestro.com.au/api/reports/123?format=JSON&AsAttachment=False&Param255=2023-02-24

3. Connecting to the API with Authorization Header

To authorise the request:

• Include the API key in the request header named Authorization.
• Do not use the query string method for new reports.

Example in Postman:

1. Go to the Headers tab.
2. Add:

• • Key: Authorization
  • Value: <your-api-key>

Note: The Host header must also be included in your request. Omitting it may cause your request to be blocked by Air Maestro's firewall.

To get your API key, click Copy API Key in Step 5. Report Schedule tab.

Rate Limiting

Each report is limited by default to 2 requests per 5 minutes.

To increase this limit, contact: [e-mail]

4. Connecting the API to Power BI

To use the API in Power BI:

1. Open Power BI Desktop.
   
   
2. From the ribbon, select Get Data > Web.
   
   
   
   
3. In the dialog box, go to the Advanced tab.
   
   
4. Paste the full API URL, including any query string parameters.
   
   
5. In the HTTP request header parameters fields, add:
   • Key: Authorization
   • Value: <your-api-key>
     
     
     
6. Click OK.
   
   
7. In the next dialog, select Anonymous and then click Connect.
   
   If configured correctly, Power BI will retrieve the data and show it in a preview/editor window.