webproxy_reporting service v1.0
Created Nov 12, 2024 at 10:02 PM

Resource: cache_hit_ratio

Cache hit Ratio for all sites

http://{device}/api/cmc.webproxy_reporting/1.0/cache_hit_ratio{?site_type_id,site_id,all_sites}
  • JSON
  • {
      "time_stamp": [
        number
      ],
      "hit": [
        number
      ],
      "requests": [
        number
      ],
      "percentage": [
        number
      ]
    }
    Property Name Type Description Notes
    cache_hit_ratio <object> Cache hit Ratio for all sites
    cache_hit_ratio.time_stamp <array of <number>> Optional;
    cache_hit_ratio.time_stamp[items] <number>
    cache_hit_ratio.hit <array of <number>> Optional;
    cache_hit_ratio.hit[items] <number>
    cache_hit_ratio.requests <array of <number>> Optional;
    cache_hit_ratio.requests[items] <number>
    cache_hit_ratio.percentage <array of <number>> Optional;
    cache_hit_ratio.percentage[items] <number>

    Resource: optimization_report

    Optimization report for sites being requested

    http://{device}/api/cmc.webproxy_reporting/1.0/optimization_report{?site_type_id,site_id,all_sites}
  • JSON
  • {
      "time_stamp": [
        number
      ],
      "lan": [
        number
      ],
      "wan": [
        number
      ],
      "percentage": [
        number
      ]
    }
    Property Name Type Description Notes
    optimization_report <object> Optimization report for sites being requested
    optimization_report.time_stamp <array of <number>> Optional;
    optimization_report.time_stamp[items] <number>
    optimization_report.lan <array of <number>> Optional;
    optimization_report.lan[items] <number>
    optimization_report.wan <array of <number>> Optional;
    optimization_report.wan[items] <number>
    optimization_report.percentage <array of <number>> Optional;
    optimization_report.percentage[items] <number>

    Resource: top_domains_by_requests

    Top 10 domains visited by number of requests.

    http://{device}/api/cmc.webproxy_reporting/1.0/top_domains_by_requests{?site_type_id,site_id,all_sites}
  • JSON
  • {
      "site_id": integer,
      "site_type_id": integer,
      "all_sites": integer,
      <prop>: any
    }
    Property Name Type Description Notes
    top_domains_by_requests <object> Top 10 domains visited by number of requests.
    top_domains_by_requests.site_id <integer> Optional;
    top_domains_by_requests.site_type_id <integer> Optional;
    top_domains_by_requests.all_sites <integer> Optional;
    top_domains_by_requests.<prop> <any> Optional;

    Resource: top_domains_by_size

    Top 10 domains visit by size.

    http://{device}/api/cmc.webproxy_reporting/1.0/top_domains_by_size{?site_type_id,site_id,all_sites}
  • JSON
  • {
      "site_id": integer,
      "site_type_id": integer,
      "all_sites": integer,
      <prop>: any
    }
    Property Name Type Description Notes
    top_domains_by_size <object> Top 10 domains visit by size.
    top_domains_by_size.site_id <integer> Optional;
    top_domains_by_size.site_type_id <integer> Optional;
    top_domains_by_size.all_sites <integer> Optional;
    top_domains_by_size.<prop> <any> Optional;

    Resource: top_url_by_size

    Top 10 URLs visit by size.

    http://{device}/api/cmc.webproxy_reporting/1.0/top_url_by_size{?site_type_id,site_id,all_sites}
  • JSON
  • {
      "site_id": integer,
      "site_type_id": integer,
      "all_sites": integer,
      <prop>: any
    }
    Property Name Type Description Notes
    top_url_by_size <object> Top 10 URLs visit by size.
    top_url_by_size.site_id <integer> Optional;
    top_url_by_size.site_type_id <integer> Optional;
    top_url_by_size.all_sites <integer> Optional;
    top_url_by_size.<prop> <any> Optional;