Introduction
The MOP reports service was built as a way to grant controlled access to customer reporting data. Each endpoint in the reports service corresponds to a cached view (table) that is regenerated nightly. This allowed the customers to retrieve their data from NetFoundry's data warehouse, but they can do so in a performant way without requiring deep knowledge of the data or complex queries.
- Endpoints with the word "daily" in them means the data is aggregated each day and there will be a reported_date field
- "Summary" indicates that the data is presented as a total sum for the given time period
- All utilization-based data is reported in bytes
- All reporting endpoints expect a startDate and endDate In the POST body as JSON.
- The reports service will only return data if the requesting user has update level permissions on the organization (network group)
Example Request:
{
"startDate":"2019-12-14",
"endDate":"2020-01-13"
}
| Endpoint | Example Response Row | Description |
| networkGroups/<networkGroupId>/resource_usage_daily | [ { "reported_date": "2019-12-14", "last_updated": "2020-01-13 01:34:00.780747+00", "endpoints": "148", "registered_clients": "121", "network_name": "My-Network-Production", "network_group_name": "MYCOMPANY", "services": "98", "services_gateway": "92", "appwans": "7", "total_gateways": "13", "services_ip_host": "5", "environment": "production", "network_id": "00000000-0000-0000-0000-00000000", "services_icmp": "1", "network_group_id": "00000000-0000-0000-0000-00000000", "total_bytes": "353051794", "total_clients": "135", "registered_gateways": "13", "hourly_peak": "17070964" } ] |
Returns stats for how many resources each network has per-day |
| networkGroups/<networkGroupId>/endpoint_usage_daily | [ { "reported_date": "2020-01-07", "environment": "production", "network_id": "00000000-0000-0000-0000-00000000", "endpoint_type": "Client", "drop_rx_bytes": "36194", "endpoint_name": "My-Endpoint", "network_group_id": "00000000-0000-0000-0000-00000000", "network_name": "My-Network-Production", "drop_tx_bytes": "41523", "total_bytes": "77717", "resource_id": "CL-4d61aa70-1342-4881-b146-00000000", "organization_name": "MYCOMPANY" } ] |
Returns how much drop_tx / drop_rx traffic each endpoint had per-day during the timeperiod |
| networkGroups/<networkGroupId>/endpoint_usage_summary | [ { "network_id": "00000000-0000-0000-0000-00000000", "endpoint_type": "Client", "drop_rx_total": "709039", "endpoint_name": "My-Endpoint", "network_group_id": "00000000-0000-0000-0000-00000000", "network_name": "My-Network-Production", "drop_tx_total": "20549191", "total_bytes": "21258230", "network_group_name": "MYCOMPANY" } ] |
Returns how much drop_tx / drop_rx traffic each endpoint had total during the timeperiod |
| networkGroups/<networkGroupId>/resource_usage_summary | [ { "registered_gateway_days": "440", "network_name": "My-Network-Production", "network_group_name": "MYCOMPANY", "registered_client_days": "4001", "total_client_days": "4751", "total_gateway_days": "442", "service_days": "5732", "network_id": "00000000-0000-0000-0000-00000000", "appwan_days": "235", "organization_id": "00000000-0000-0000-0000-00000000", "total_bytes": "30445057884", "active_network_days": "30", "hourly_peak": "368369477" } ] |
Measures how many "active days" each resource has and presents the sums |
Comments
0 comments