applications

Documentation

Index

• type Apps
• type GetAppsFilters
• type MostImpactedGeo
• type Service
  • func New(c *zdx.Client) *Service
  • func (service *Service) GetAllApps(filters GetAppsFilters) (*Apps, *http.Response, error)
  • func (service *Service) GetApp(appID string, filters GetAppsFilters) (*Apps, *http.Response, error)
  • func (service *Service) GetAppMetrics(appID string, filters GetAppsFilters) (*common.Metric, *http.Response, error)
  • func (service *Service) GetAppScores(appID string, filters GetAppsFilters) (*common.Metric, *http.Response, error)
• type Stats

Types

type Apps

type Apps struct {
	ID              int              `json:"id"`
	Name            string           `json:"name,omitempty"`
	Score           int              `json:"score,omitempty"`
	MostImpactedGeo *MostImpactedGeo `json:"most_impacted_geo,omitempty"`
	Stats           *Stats           `json:"stats,omitempty"`
}

type GetAppsFilters

type GetAppsFilters struct {
	common.GetFromToFilters
	// The Zscaler location (ID). You can add multiple location IDs.
	Loc []int `json:"loc,omitempty" url:"loc,omitempty"`
	// The department (ID). You can add multiple department IDs.
	Dept []int `json:"dept,omitempty" url:"dept,omitempty"`
	// The active geolocation (ID). You can add multiple active geolocation IDs.
	Geo []string `json:"geo,omitempty" url:"geo,omitempty"`
}

type MostImpactedGeo

type MostImpactedGeo struct {
	ID      int    `json:"id"`
	City    string `json:"city,omitempty"`
	Region  string `json:"region,omitempty"`
	State   string `json:"state,omitempty"`
	Country string `json:"country,omitempty"`
	GeoType string `json:"geo_type,omitempty"`
}

type Service

type Service struct {
	Client *zdx.Client
}

func New

func New(c *zdx.Client) *Service

func (*Service) GetAllApps

func (service *Service) GetAllApps(filters GetAppsFilters) (*Apps, *http.Response, error)

Lists all active applications configured for a tenant. The endpoint gets each application's ZDX score (default for the last 2 hours), most impacted location, and the total number of users impacted. To learn more, see About the ZDX Dashboard at https://help.zscaler.com/zdx/about-zdx-dashboard.

func (*Service) GetApp

func (service *Service) GetApp(appID string, filters GetAppsFilters) (*Apps, *http.Response, error)

Gets the application’s ZDX score (for the last 2 hours), most impacted locations, and the total number of users impacted. To learn more, see About the ZDX Score at https://help.zscaler.com/zdx/about-zdx-score#user.

func (*Service) GetAppMetrics

func (service *Service) GetAppMetrics(appID string, filters GetAppsFilters) (*common.Metric, *http.Response, error)

Gets the application's metric trend. For Web Probes, you can access Page Fetch Time, Server Response Time, DNS Time or Availability. If not specified, it defaults to Page Fetch Time (PFT). For CloudPath Probes, you can access latency metrics for End to End, Client - Egress, Egress - Application, ZIA Service Edge - Egress, and ZIA Service Edge - Application. If not specified, it defaults to End to End latency. If the time range is not specified, the endpoint defaults to the last 2 hours.

func (*Service) GetAppScores

func (service *Service) GetAppScores(appID string, filters GetAppsFilters) (*common.Metric, *http.Response, error)

Gets the application's ZDX score trend. If the time range is not specified, the endpoint defaults to the last 2 hours.

type Stats

type Stats struct {
	ActiveUsers   int `json:"active_users"`
	ActiveDevices int `json:"active_devices"`
	NumPoor       int `json:"num_poor"`
	NumOkay       int `json:"num_okay"`
	NumGood       int `json:"num_good"`
}