Understanding the Analytics API

Analytics API provides programmatic access to key Zscaler analytics data retrieved from various data sources via a centralized, flexible interface. With this API, you can build custom dashboards, analyze trends, and extract insights related to Zscaler's SaaS Security, Shadow IT, Internet of Things (IoT) Security, Zero Trust Firewall, cybersecurity posture, and web traffic behavior across your organization. It also provides access to Zscaler Digital Experience (ZDX)-related data and insights.

Analytics API implements GraphQL-based architecture, accessible via OneAPI gateway. It integrates with Authentication Service, Zscaler's unified identity platform, for authorization and role-based access control. By leveraging GraphQL, the API supports a scalable and hierarchical query model, strongly typed schema, introspection, efficient and flexible data retrieval, and optimized client-side development with the use of a single endpoint. It supports API queries spanning across multiple data domains, offering flexibility and precision in data querying. It uses caching and data transformation layers to enhance performance, isolates system dependencies, and provides a consistent data access experience across services.

Before using this API, Zscaler recommends reviewing Working with the Analytics API for information regarding prerequisites, authentication, GraphQL schema introspection, and how to make API requests. To learn about using the ZDX GraphQL API supported within Analytics API, see Working with the ZDX GraphQL API. To learn about the GraphQL API schema structure, supported data domains, and error handling, see the Analytics API Reference.