HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
Guides

MRT APIs Collection

The MRT APIs Collection corresponds to the Monitoring, Reporting & Troubleshooting(MRT) API Reference available on the Developer Hub. It lets you explore APIs that provide visibility into monitoring sites, devices, clients, etc., all within Postman.

Prerequisites

Before you begin, make sure that:

Making API Calls

To make an API call:

  1. Select the desired API Endpoint from the Postman collection.
  2. Review & update any required parameters or request details.
  3. Click Send to execute the API call
  4. Review the response to verify the API output.

Example: Get a list of Access Points

To retrieve a list of access points, use the Get a list of Access Points request within the Access Points folder in Monitoring category from the collection. This API requires no mandatory API parameters, making it simple to execute right out of the box.

  1. Ensure that you've generated your access token as described in the Authentication Setup.
  2. Navigate to the Get a list of Access Points API in the Postman Collection
  3. Optionally, configure the following query parameters as needed in the request's Params tab on Postman
    1. filter: Apply filters to narrow the API results(Supports OData Version 4.0 filter string)
    2. sort: Comma separated list of sort expressions.
    3. limit: Denotes the maximum number of access points returned in the response.(Default is 20)
    4. next: Specifies the pagination cursor for the next page of resources.
      You can find more details of the API's parameter on the API Reference guide
  4. Click Send to execute the request.
  5. If successful, the response will return a list of access points, optional filtered as per the API parameters.
Steps in action:

Steps in action: executing the Get list of Access Points API in Postman