Skip to main content

Analytics API Reference

GraphQL API for analytics, reporting, and digital experience monitoring.

Getting Started​

To learn more about setting up and using the Analytics API, see Analytics API Getting Started.

Endpoint​

https://api.zsapi.net/zins/graphql

Authentication​

Include your API key in the Authorization header:

Authorization: Bearer YOUR_BEARER_TOKEN

API Domains​

This API is organized into domains, each representing a specific area of functionality:

  • Alerts - Alert-based queries that analyze ongoing and historic security alerts, joining alert evaluations with tagged security transactions from Z_FABRIC. (2 queries)
  • App Inventory - Entry point for application inventory queries (1 query)
  • SaaS Security - Saas Security contains queries for CASB data. Cloud Access Security Broker (CASB) provides data and threat protection for data at rest in cloud services. (1 query)
  • Cloud Application - The Cloud application domain provides data related to the company's cloud application, such as traffic (1 query)
  • Cyber Security - Cybersecurity is the state of being protected in cyberspace, including measures taken to protect computer systems against unauthorized access or attack. It refers to the policies, processes, and technologies to protect networks, devices, and data from cybercrime and data breaches. This domain provides data, including incident responses. (2 queries)
  • Zero Trust Firewall - Zscaler Zero Trust Firewall protects web and non-web traffic for all users, applications, and locations with the industry’s most comprehensive cloud-native security service edge (SSE) platform. This domain provides report data for specific type, like location, action. (7 queries)
  • Generative AI - Sensitive Data Transactions: View the sensitive content, based on DLP Engine, discovered per application. (87 queries)
  • IOT - Securing IoT begins with knowing which devices are connected to your network and what they’re doing. Zscaler IoT Device Visibility extends the power of the Zero Trust Exchange™ platform, using AI/ML to automatically detect, identify, and classify IoT devices across your estate. This domain provides device data and statistics. (1 query)
  • Risk Score - The Risk Score domain provides data related to your organization's overall risk posture, including contributing factors and industry benchmarks. (2 queries)
  • Shadow IT - Shadow IT discovery (unsanctioned apps in use, which increases risk for an organization) report data. (2 queries)
  • Web Traffic - ZIA Web traffic report data or specific type, like protocols and threat categories. (14 queries)
  • ZDX - Queries related to ZDX (Zscaler Digital Experience) data. (2 queries)

Using Domains​

Access domain queries through the root Query type:

query {
  DOMAIN_NAME {
    # Domain-specific queries here
  }
}

Types​

Introspection​

You can explore the schema programmatically:

query IntrospectionQuery {
  __schema {
    queryType { name }
    mutationType { name }
    types {
      name
      kind
      description
    }
  }
}