Monitor Service OData API

Create custom reports and analyze your monitoring data

The Monitor Service API uses the Open Data (OData) protocol, which is a Web protocol for querying and updating data, built upon Web technologies such as HTTP. For more information about the OData protocol, see: http://www.odata.org.

The Monitor Service API is built on top of SQL Server databases using WCF Data Services that are populated during processing and consolidation. Two endpoints are exposed:

  1. The Data endpoint exposes read-only access directly to the database entities and can be accessed using the OData query language. This endpoint allows highly flexible access in terms of filtering and column selection. 
  2. The Methods endpoint exposes service operations that are used by Citrix Director to retrieve data that requires complex grouping and high performance standards, such as queries on the Dashboard and Trends pages. Methods are used only in Director itself so are used mainly internally within Citrix and by Citrix partners. 

Exchange Forum

Documentation

Note: you must have Citrix account credentials to access certain SDK content. If you do not already have a Citrix account, please use the Developer Registration button of the right side of this page to create an account.

Watch related videos on the Citrix Developer YouTube channel.

Share your ideas with us

SDK Documentation Feedback

We are working to improve our SDK deliverables to make them easier to use.  Click the link below to take a quick survey and share your feedback with our team. 

Open the survey

Create your Citrix Developer account today
An account gives you access to all of the benefits of the Citrix Developer community.

You’ve built a great solution integrating with Citrix APIs, now continue the next step of your journey with Citrix Ready.