Skip to main content

Reporting API

The Reporting API is a template-based system that makes the most common queries simpler and more efficient than writing direct Elasticsearch queries. It abstracts away the Elasticsearch query formatting required by the Metrics API, at the cost of some flexibility. For most use cases, the Reporting API is the better choice—both for ease of writing queries and for simpler handling of the returned data.

Send a GET request to the following base URL, replacing <templateName> with the name of the template you want to run:

GET https://gateway.production.netfoundry.io/reporting/v1/template-search/<templateName>

Staging and sandbox environments use the same path with their respective hostnames (gateway.staging.netfoundry.io, gateway.sandbox.netfoundry.io). Authentication is required. The caller must have the Network Group admin or Network read role.

Common parameters​

These parameters are accepted by most templates:

ParameterDescription
gteGreater than or equal to (start of time range)
lteLess than or equal to (end of time range)
sizeNumber of documents to return

Network utilization (ncutilization)​

Network utilization data for networks. Data is retrieved by template name and query parameters.

ncutilization_usage_summary_v8_tmpl​

Top 10 usage summary for a network.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_usage_summary_v8_tmpl?gte=2025-11-30T18:30:00.000Z&lte=2025-12-31T18:30:00.000Z&networkId=2dc478a6-bc00-4ae1-afd8-50e90c65527c&networkGroupId=62a2a22a-55dc-4c6a-95aa-f911ff72cc5e&indexName=ncutilization

Response​

{"took":52,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":3,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"tx":{"value":160314056},"rx":{"value":1059681493}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYes2025-11-30T18:30:00.000Z
ltestringYes2025-12-31T18:30:00.000Z
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_metrics_usage_sum_by_component_tmpl​

Aggregated usage data for a network. Usage can be aggregated by router, endpoint, service, or hosted identity.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_metrics_usage_sum_by_component_tmpl?gte=1765265253849&lte=1765351653849&size=0&componentName=&componentValue=&aggComponentName=nf_host_name.keyword&aggTermSize=5000&attributes=&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0&indexName=ncutilization

Response​

{"took":25,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":21,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"items":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"west-ZET-1","doc_count":70055,"item_sum":{"value":254233538}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
componentNamestringNonf_service_name or nf_endpoint_name
componentValuestringNoCorresponding value for componentName
aggComponentNamestringNoAggregate by component: nf_host_name.keyword, nf_edge_router_name.keyword, nf_service_name.keyword, or nf_endpoint_name.keyword
attributesArray of stringNoIdentity attribute (URL-encoded JSON array)
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)
sizeintegerYesNumber of documents to return

ncutilization_active_endpoints_tmpl​

Number of active identities for a given time interval.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_active_endpoints_tmpl?gte=now-24h&lte=now&size=0&timeZone=Africa/Abidjan&interval=10m&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&indexName=ncutilization

Response​

{"took":69,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":15,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"date_buckets":{"buckets":[{"key_as_string":"2025-12-11T12:40:00.000+05:30","key":1765437000000,"doc_count":372,"unique_identities":{"value":3}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
timeZonestringNoTime zone (e.g., Africa/Abidjan)
intervalstringYesTime interval, e.g., m (minute), h (hourly), d (daily)
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_metrics_usage_bytes_by_component_v8_tmpl​

Shows top components by total usage and their usage trends over time for V8 networks.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_metrics_usage_bytes_by_component_v8_tmpl?gte=1765248336396&lte=1765334736396&size=0&aggTermSize=10&timeZone=Africa/Abidjan&interval=1m&componentName=&componentValue=&aggComponentName=host_name.keyword&attributes=&networkId=fbaec4ed-c89f-4f33-b6ef-60d199fa08fd&networkGroupId=b8e4f0a8-932a-42da-bd59-7e985b65be58&indexName=ncutilization

Response​

{"took":48,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":15,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"top10Services":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"west-ZET","doc_count":9563,"time_buckets":{"buckets":[{"key_as_string":"2025-12-10T18:41:00.000+05:30","key":1765372260000,"doc_count":8,"tx":{"value":7446},"rx":{"value":49046},"total_sum":{"value":56492}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
timeZonestringNoTime zone (e.g., Africa/Abidjan)
intervalstringNoTime interval
componentNamestringNohost_name, service_name, or identity_name
componentValuestringNoCorresponding value for componentName
aggComponentNamestringNoAggregate by component: identity_name.keyword, etc.
attributesArray of stringNoIdentity attribute (URL-encoded JSON array)
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_metrics_usage_bytes_by_component_tmpl​

Shows top components by total usage and their usage trends over time.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_metrics_usage_bytes_by_component_tmpl?gte=1765265754138&lte=1765352154138&size=0&timeZone=Africa/Abidjan&interval=5m&componentName=nf_endpoint_id&componentValue=649e3a27-d234-411c-ac00-76d146b52777&aggComponentName=nf_service_name.keyword&aggTermSize=10&attributes=&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&indexName=ncutilization

Response​

{"took":136,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":21,"failed":0},"hits":{"total":{"value":3035,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"items":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"controller-ZET","doc_count":3035,"timebuckets":{"buckets":[{"key_as_string":"2025-12-11T06:15:00.000+05:30","key":1765413900000,"doc_count":30,"usage_bytes":{"value":100441}}]},"usage_bytes":{"value":10161194}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
timeZonestringNoTime zone (e.g., Africa/Abidjan)
intervalstringYesTime interval, e.g., m (minute), h (hourly), d (daily)
componentNamestringNonf_service_name or nf_endpoint_name
componentValuestringNoCorresponding value for componentName
aggComponentNamestringNonf_host_name.keyword, nf_edge_router_name.keyword, nf_service_name.keyword, or nf_endpoint_name.keyword
aggTermSizeintegerYesNumber of top components to return
attributesArray of stringNoIdentity attribute (URL-encoded JSON array)
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_endpoint_visualization_tmpl​

Provides endpoint-level visualization with a hierarchical breakdown of service, host, router, and usage type associations.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_endpoint_visualization_tmpl?gte=1765227117723&lte=1765313517723&size=0&aggTermSize=500&endpointId=1d25f9f5-4610-40a3-be43-c388b120afff&serviceName=xyz-serivce-name&networkId=4ce06395-0b93-4383-b365-9a64441d0bc9&networkGroupId=8ce06395-0b93-4383-b365-9a64441d0bc9&indexName=ncutilization

Response​

{"took":13,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":15,"failed":0},"hits":{"total":{"value":6400,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"endpoint_bucket":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"1":{"value":21415089},"key":"controller-ZET","doc_count":6400,"services_bucket":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"1":{"value":21415089},"key":"splash.west.ziti","doc_count":6400,"hosts_bucket":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"1":{"value":21035203},"key":"controller-ZET","doc_count":6282,"routers_bucket":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"1":{"value":21035203},"key":"public us-east-1 (DO NOT DELETE)","doc_count":6282,"usage_type_bucket":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"1":{"value":17934609},"key":"usage.ingress.tx","doc_count":3138},{"1":{"value":3100594},"key":"usage.egress.tx","doc_count":3144}]}}]}}]}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top components to return
endpointIdstringYesEndpoint ID
serviceNamestringYesName of the service
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_metrics_usage_sum_by_component_v8_tmpl​

Returns the top 10 services by network usage, calculating ingress and egress traffic, deriving total traffic per service, and sorting results by total consumption.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_metrics_usage_sum_by_component_v8_tmpl?gte=1765248336396&lte=1765334736396&size=0&aggTermSize=10&interval=&componentName=&componentValue=&aggComponentName=host_name.keyword&attributes=&networkId=fbaec4ed-c89f-4f33-b6ef-60d199fa08fd&networkGroupId=b8e4f0a8-932a-42da-bd59-7e985b65be58&indexName=ncutilization

Response​

{"took":39,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":15,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"Top10Services":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"ctrl-ZET","doc_count":8234,"tx":{"value":6709431},"rx":{"value":55638455},"total_sum":{"value":62347886}},{"key":"west-ZET","doc_count":9007,"tx":{"value":8527067},"rx":{"value":50279387},"total_sum":{"value":58806454}},{"key":"east-ZET","doc_count":6395,"tx":{"value":6237308},"rx":{"value":36118948},"total_sum":{"value":42356256}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top components to return
intervalstringYesTime interval
componentNamestringNoComponent name to filter by
componentValuestringNohost_name, identity_name, or service_name
aggComponentNamestringNohost_name.keyword, edge_router_name.keyword, service_name.keyword, or identity_name.keyword
attributesArray of stringNoIdentity attribute (URL-encoded JSON array)
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_top_components_tmpl​

Get top network data usage.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_top_components_tmpl?gte=now-24h&lte=now&size=0&aggTermSize=5&aggComponentName=nf_edge_router_name.keyword&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&indexName=ncutilization

Response​

{"took":10,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":15,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"unique_items":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"west-ZET-1","doc_count":34678,"item_sum":{"value":125740642}},{"key":"east-ZET-1","doc_count":30350,"item_sum":{"value":107566769}},{"key":"controller-ZET","doc_count":12145,"item_sum":{"value":40660271}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top components to return
aggComponentNamestringYesComponent name to aggregate by
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_usage_summary_tmpl​

Network usage summary (usage includes both ingress and egress).

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_usage_summary_tmpl?gte=1764547200000&lte=1767225600000&size=0&aggTermSize=2&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&indexName=ncutilization

Response​

{"took":55,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":3,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"usage_sums":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"usage.ingress.tx","doc_count":319944,"usage_bytes":{"value":1981558965}},{"key":"usage.egress.tx","doc_count":319890,"usage_bytes":{"value":290350612}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top components to return
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_rx_and_tx_tmpl​

Provides a time-based view of usage showing the top 2 usage types (ingress and egress) and their total consumption within each time interval.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_rx_and_tx_tmpl?gte=1764835710000&lte=1765440510203&size=0&interval=1h&componentName=&componentValue=&attributes=&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0&indexName=ncutilization

Response​

{"took":99,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":3,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"timebuckets":{"buckets":[{"key_as_string":"2025-09-14T23:00:00.000+05:30","key":1757871000000,"doc_count":2058,"usage_sums":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"usage.ingress.tx","doc_count":1029,"usage_bytes":{"value":6360284}},{"key":"usage.egress.tx","doc_count":1029,"usage_bytes":{"value":923741}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
intervalstringYesTime interval, e.g., 5m
componentNamestringNonf_service_name or nf_endpoint_name
componentValuestringNoCorresponding value for componentName
attributesArray of stringNoIdentity attribute (URL-encoded JSON array)
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_resource_tmpl​

Groups data by a unique component, calculates total usage for each, and returns the top items.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_resource_tmpl?gte=now-7d&lte=now&size=0&aggTermSize=3500&aggComponentName=nf_service_name.keyword&componentName=&componentValue=&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&indexName=ncutilization

Response​

{"took":44,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":3,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"unique_items":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"mgmt-api","doc_count":257909,"item_sum":{"value":977925697}},{"key":"splash.west.ziti","doc_count":165686,"item_sum":{"value":553969015}},{"key":"splash-east.ziti","doc_count":119548,"item_sum":{"value":397157067}},{"key":"Sample_Service","doc_count":35,"item_sum":{"value":73087}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top components to return
aggComponentNamestringNoAggregate by component name, e.g., nf_service_name.keyword
componentNamestringNonf_service_name, nf_edge_router_name, or nf_endpoint_name
componentValuestringNoCorresponding value for componentName
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_component_usage_tmpl​

Groups usage data into time-based (minute/hour/day) buckets and calculates the total usage for each interval.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_component_usage_tmpl?indexName=ncutilization&networkGroupId=5da38516-1111-4f7a-abf8-68c233f29b5d&aggFieldName=nf_edge_router_name.keyword&aggFieldValue=aggFieldValue&gte=now-7d&lte=now&interval=1d&timeZone=UTC&size=0

Response​

{"took":211,"timed_out":false,"_shards":{"total":33,"successful":33,"skipped":9,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"MinuteBucket":{"buckets":[{"key_as_string":"2025-12-08T00:00:00.000Z","key":1765152000000,"doc_count":19465,"totalusage":{"value":7.0662875E7}},{"key_as_string":"2025-12-09T00:00:00.000Z","key":1765238400000,"doc_count":34910,"totalusage":{"value":1.26675482E8}},{"key_as_string":"2025-12-10T00:00:00.000Z","key":1765324800000,"doc_count":34707,"totalusage":{"value":1.25934026E8}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncutilization)
networkGroupIdUUIDYesNetwork group ID
aggFieldNamestringNoComponent name to aggregate by, e.g., nf_edge_router_name.keyword
aggFieldValuestringNoCorresponding value for aggFieldName
gtestringYesStart of time range
ltestringYesEnd of time range
intervalintegerYesTime interval (e.g., 1d)
timeZonestringNoTime zone (e.g., UTC)
sizeintegerYesNumber of documents to return

ncutilization_rx_and_tx_dashboard_v8_tmpl​

Provides aggregated data usage for ingress and egress in time-based buckets.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_rx_and_tx_dashboard_v8_tmpl?gte=1765267307398&lte=1765353707398&size=0&aggTermSize=10&timeZone=Asia/Calcutta&interval=1m&calendar_interval=1m&componentName=&componentValue=&aggComponentName=10&attributes=&networkId=fde19860-9fff-43a2-93e0-64c6d3f00673&networkGroupId=82d70e3f-deda-469f-be1a-9c40561ede5d&indexName=ncutilization

Response​

{"took":31,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":15,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"time_buckets":{"buckets":[{"key_as_string":"2025-12-10T18:38:00.000+05:30","key":1765372080000,"doc_count":16,"tx":{"value":14865},"rx":{"value":96794}},{"key_as_string":"2025-12-10T18:39:00.000+05:30","key":1765372140000,"doc_count":17,"tx":{"value":15656},"rx":{"value":103634}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
timeZonestringNoTime zone (e.g., Asia/Calcutta)
calendar_intervalstringYesTime interval: m (minute), h (hourly), d (daily)
componentNamestringNoidentity_name or service_name
componentValuestringNoCorresponding value for componentName
attributesArray of stringNoIdentity attribute (URL-encoded JSON array)
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
indexNamestringYesIndex name (ncutilization)

ncutilization_top_components_v8_tmpl​

Top component usage data (ingress + egress) for V8 networks.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncutilization_top_components_v8_tmpl?networkId=2dc478a6-bc00-4ae1-afd8-50e90c65527c&networkGroupId=62a2a22a-55dc-4c6a-95aa-f911ff72cc5e&aggComponentName=edge_router_name.keyword&gte=now-24h&lte=now&size=0&component_size=5&indexName=ncutilization

Response​

{"took":76,"timed_out":false,"_shards":{"total":27,"successful":27,"skipped":15,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"Top10Services":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"public us-east-1","doc_count":14073,"tx":{"value":12665823},"rx":{"value":84601909},"total_sum":{"value":97267732}},{"key":"public us-west-1","doc_count":9563,"tx":{"value":8807983},"rx":{"value":57434881},"total_sum":{"value":66242864}}]}}}

Query parameters​

ParameterTypeRequiredDescription
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
aggComponentNamestringYesComponent to aggregate by: edge_router_name, identity_name, or service_name
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
component_sizeintegerYesNumber of top components to return (default: 10)
indexNamestringYesIndex name (ncutilization)

Entity changes (ncentitychanges)​

Entity change events for a network. Entities include identities, routers, configs, services, posture check types, and more.

ncentitychanges_events_v8_tmpl​

Get entity change events. Entities can be identities, routers, configs, services, posture check types, and more.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncentitychanges_events_v8_tmpl?indexName=ncentitychanges&gte=1732991400000&lte=1765446049596&size=5000&networkGroupId=62a2a22a-55dc-4c6a-95aa-f911ff72cc5e&networkId=5e8d9c1d-297e-4be5-88af-7297da08dd32&networkEvent=&networkEventResourceType=&networkEventType=&networkEventSort=desc

Response​

{"took":61,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":6,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncentitychanges-2025.12.08-000979","_id":"j3fUBJsBYhEz8_y8mVPB","_score":null,"_source":{"networkName":"rg-stag-test-net-HA","entity_id":"FeYI5raXh","@timestamp":"2025-12-09T20:36:38.273Z","networkGroupId":"62a2a22a-55dc-4c6a-95aa-f911ff72cc5e","network_id":"5e8d9c1d-297e-4be5-88af-7297da08dd32","entity_name":"ryan galletto(managed from 8466464f-dcd4-46e9-a794-2bf68acc144b)","event":{"eventType":"updated","entityType":"identities","namespace":"entityChange","timestamp":"2025-12-09T20:36:30.302350927Z"},"tags":["customer"],"cloudziti":true,"target_index":"ncentitychanges","env":"staging"},"sort":[1765312590302]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncentitychanges)
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
networkEventstringNoFilter on any document field value
networkEventResourceTypestringNoEntity type, e.g., identities, routers, postureChecks
networkEventTypestringNoEvent type: updated, created, or deleted
networkEventSortstringNoSort order (desc or asc)
entityIdstringNoAn entity ID (e.g., identity, router)

Service events (ncserviceevents)​

Service event data for a network. Includes dial success and failure details.

ncserviceevents_health_tmpl_v8​

Get a network service health report including dial success and failure details.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncserviceevents_health_tmpl_v8?indexName=ncserviceevents&gte=now-24h&lte=now&size=0&networkGroupId=62a2a22a-55dc-4c6a-95aa-f911ff72cc5e&aggTermSize=10&networkId=2dc478a6-bc00-4ae1-afd8-50e90c65527c

Response​

{"took":4,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":2,"failed":0},"hits":{"total":{"value":9,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"group_by_service_name":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"","doc_count":4,"eventFailure":{"doc_count":1,"sumFailure":{"value":98}},"eventSuccess":{"doc_count":3,"sumSuccess":{"value":27}},"dial_failure_rate":{"value":0.21599999999999997}},{"key":"nf-mgmt-service","doc_count":5,"eventFailure":{"doc_count":0,"sumFailure":{"value":0}},"eventSuccess":{"doc_count":5,"sumSuccess":{"value":68}},"dial_failure_rate":{"value":1}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncserviceevents)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
networkIdUUIDYesNetwork ID

ncserviceevents_health_count_tmpl​

Returns the top service event types along with the total event count for each type (service.dial.success, service.dial.fail).

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncserviceevents_health_count_tmpl?indexName=ncserviceevents&gte=now-24h&lte=now&size=0&aggTermSize=4&timeZone=UTC&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&serviceId=d7840865-887a-4bca-a6e3-10c14bf7532c

Response​

{"took":154,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":0,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"event_types":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncserviceevents)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top event types to return
timeZonestringNoTime zone
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
serviceIdUUIDNoService ID

ncserviceevents_health_tmpl​

Get a service report showing the success count, failure count, and failure rate.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncserviceevents_health_tmpl?indexName=ncserviceevents&gte=now-24h&lte=now&size=0&aggTermSize=10&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48

Response​

{"took":204,"timed_out":false,"_shards":{"total":13,"successful":13,"skipped":0,"failed":0},"hits":{"total":{"value":2,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"group_by_service_name":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"ABC-CC-YYY","doc_count":2,"eventSuccess":{"doc_count":2,"sumSuccess":{"value":5}},"eventFailure":{"doc_count":0,"sumFailure":{"value":0}},"dial_failure_rate":{"value":1}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncserviceevents)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID

ncserviceevents_health_count_tmpl_v8​

Returns the top service event types along with the total event count for each type (service.dial.success, service.dial.fail) for V8 networks.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncserviceevents_health_count_tmpl_v8?indexName=ncserviceevents&gte=now-24h&lte=now&size=0&networkGroupId=b8e4f0a8-932a-42da-bd59-7e985b65be58&aggTermSize=4&networkId=fbaec4ed-c89f-4f33-b6ef-60d199fa08fd&serviceId=7oUrIe7frWkkGCAm6jmdq&timeZone=UTC

Response​

{"took":9,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":3,"failed":0},"hits":{"total":{"value":2910,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"event_types":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"service.dial.success","doc_count":2910,"sum":{"value":11723.0}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncserviceevents)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
networkGroupIdUUIDYesNetwork group ID
aggTermSizeintegerYesNumber of top event types to return
networkIdUUIDYesNetwork ID
serviceIdstringNoService ID
timeZonestringNoTime zone (e.g., UTC)

Fabric circuits (ncfabriccircuits)​

Fabric circuit data for a network. Includes traffic flow, dial logs, and service health time series.

ncfabriccircuits_identity_traffic_analysis_tmpl​

Provides a complete traffic flow hierarchy: from initiator IP to ingress endpoint to service to host to terminator address. Use this template to identify top traffic initiators, trace how traffic enters the network, see which services and hosts are involved, and understand end-to-end traffic paths.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncfabriccircuits_identity_traffic_analysis_tmpl?indexName=ncfabriccircuits&gte=2025-12-09T04:25:09Z&lte=2025-12-10T04:25:09Z&size=0&endpointId=&serviceId=&networkId=a7e42326-65e3-4adf-82bc-c2398250c59d&networkGroupId=ac767028-f0dd-4c1e-ab68-3fb568873ec6&terminatorRemoteIp=&terminatorRemotePort=&initiatorRemoteIp=

Response​

{"took":719,"timed_out":false,"_shards":{"total":36,"successful":36,"skipped":0,"failed":0},"hits":{"max_score":null,"hits":[]},"aggregations":{"initiator":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"IP","doc_count":841488,"ingress_entity":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"test-ER","doc_count":841488,"service_name":{"doc_count_error_upper_bound":1476,"sum_other_doc_count":640954,"buckets":[{"key":"test-key","doc_count":59354,"hosting_entity":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"testGATEWAY","doc_count":59354,"terminator_remote":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[]}}]}}]}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncfabriccircuits)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
endpointIdUUIDNoEndpoint ID
serviceIdUUIDNoService ID
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
terminatorRemoteIpArray of stringNoTerminator remote IP addresses (URL-encoded JSON array)
terminatorRemotePortArray of stringNoTerminator remote ports (URL-encoded JSON array)
initiatorRemoteIpArray of stringNoInitiator remote IP addresses (URL-encoded JSON array)
serviceNamestringNoName of the service
hostNamestringNoName of the host

ncfabriccircuits_service_endpoint_dial_logs_tmpl​

Service dial endpoint logs for a network.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncfabriccircuits_service_endpoint_dial_logs_tmpl?indexName=ncfabriccircuits&gte=1765265756319&lte=1765352156319&size=500&endpointId=649e3a27-d234-411c-ac00-76d146b52777&serviceId=&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&networkEventType=&endpointName=&serviceName=

Response​

{"took":7,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":3,"failed":0},"hits":{"total":{"value":253,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncfabriccircuits-2025.12.10-000655","_id":"86QPDZsBcSbwYFP9X1g8","_score":null,"_source":{"nf_host_name":"controller-ZET","timestamp":"2025-12-11T10:57:46.22353655Z","nf_service_id":"8c889083-1a67-4ce2-b519-a1ab73a22d91","nf_endpoint_name":"controller-ZET","event_type":"created","namespace":"fabric.circuits","nf_endpoint_id":"c728ef27-59d3-4471-ae74-14566336475f","network_id":"951eaaef-9d60-4db2-8401-c29dffcee637","network_name":"ChaosNet-V7","service_id":"4r2hXuwoiY6uRFDnQ66NVw","circuit_id":"abwkjjyxe","nf_service_name":"splash-east.ziti"},"sort":[1765450669780]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncfabriccircuits)
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
endpointIdUUIDNoEndpoint ID
serviceIdUUIDNoService ID
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
networkEventTypestringNoEvent type, e.g., created
endpointNamestringNoEndpoint name
serviceNamestringNoService name

ncserviceevents_health_time_series_tmpl_v8​

Produces a time-series view of event activity. Events are grouped by time with a breakdown by event type within each time period and the total count of each event type per interval.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncserviceevents_health_time_series_tmpl_v8?indexName=ncfabriccircuits&aggInterval=3600000ms&timeZone=Africa/Abidjan&gte=now-24h&lte=now&size=0&aggTermSize=10&serviceId=7oUrIe7frWkkGCAm6jmdq&networkId=fbaec4ed-c89f-4f33-b6ef-60d199fa08fd&networkGroupId=b8e4f0a8-932a-42da-bd59-7e985b65be58

Response​

{"took":119,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"items":{"buckets":[{"key_as_string":"2025-12-15T07:00:00.000Z","key":1765782000000,"doc_count":170,"event_types":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"created","doc_count":170,"sum":{"value":0.0}}]}},{"key_as_string":"2025-12-15T08:00:00.000Z","key":1765785600000,"doc_count":756,"event_types":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"created","doc_count":756,"sum":{"value":0.0}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncfabriccircuits)
aggIntervalstringYesFixed time interval for bucketing, e.g., 3600000ms, 5m, 1h, 1d
timeZonestringNoTime zone (e.g., Africa/Abidjan)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of event types to return per time bucket
serviceIdstringNoService ID
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID

ncfabriccircuits_identity_traffic_analysis_v8_tmpl​

Provides a complete traffic flow hierarchy for V8 networks: from initiator IP to ingress endpoint to service to host to terminator address. Use this template to identify top traffic initiators, trace how traffic enters the network, see which services and hosts are involved, and understand end-to-end traffic paths.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncfabriccircuits_identity_traffic_analysis_v8_tmpl?indexName=ncfabriccircuits&gte=2025-12-08T20:54:47Z&lte=2025-12-09T20:54:47Z&endpointId=&serviceId=&networkId=5e8d9c1d-297e-4be5-88af-7297da08dd32&networkGroupId=62a2a22a-55dc-4c6a-95aa-f911ff72cc5e&terminatorRemoteIp=&terminatorRemotePort=&initiatorRemoteIp=

Response​

{"took":90,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"max_score":null,"hits":[]},"aggregations":{"initiator":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"","doc_count":138,"ingress_entity":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"ryan galletto(managed from 8466464f-dcd4-46e9-a794-2bf68acc144b)","doc_count":138,"service_name":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"nf-mgmt-service","doc_count":138,"hosting_entity":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"nf-mgmt-identity.29851539-1f65-46c3-9932-b98065f54e32","doc_count":138,"terminator_remote":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[]}}]}}]}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncfabriccircuits)
gtestringYesStart of time range
ltestringYesEnd of time range
endpointIdstringNoIdentity ID
serviceIdstringNoService ID
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
terminatorRemoteIpArray of stringNoTerminator remote IP addresses (URL-encoded JSON array)
terminatorRemotePortArray of stringNoTerminator remote ports (URL-encoded JSON array)
initiatorRemoteIpArray of stringNoInitiator remote IP addresses (URL-encoded JSON array)

ncfabriccircuits_service_endpoint_dial_logs_v8_tmpl​

Service dial endpoint logs for V8 networks.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncfabriccircuits_service_endpoint_dial_logs_v8_tmpl?indexName=ncfabriccircuits&gte=1765246181015&lte=1765332581015&size=500&endpointId=&serviceId=7oUrIe7frWkkGCAm6jmdq&networkId=fbaec4ed-c89f-4f33-b6ef-60d199fa08fd&networkGroupId=b8e4f0a8-932a-42da-bd59-7e985b65be58&networkEventType=&endpointName=&serviceName=

Response​

{"took":20,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":2,"failed":0},"hits":{"total":{"value":8819,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncfabriccircuits-2025.12.10-000655","_id":"y7-hDZsBcSbwYFP9eRZ-","_score":null,"_source":{"host_name":"west-ZET","timestamp":"2025-12-11T13:37:12.273163983Z","event_type":"created","namespace":"fabric.circuits","service_name":"splash.west.ziti","network_id":"95304061-4540-4220-befb-61fe8fcf75b6","network_name":"ChaosNet-V8","identity_name":"east-ZET","service_id":"65y08gAO384h6TaeTRBrBY","circuit_id":"ZEuUIiBlj"},"sort":[1765460232273]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncfabriccircuits)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
endpointIdstringNoIdentity ID
serviceIdstringNoService ID
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID
networkEventTypestringNoEvent type, e.g., created
endpointNamestringNoIdentity name
serviceNamestringNoService name

ncfabriccircuits_service_dial_health_tmpl​

Produces a time-series view of dial failures: when failures occurred (time buckets), what caused them (failure cause breakdown), and the most frequent failure reasons in each time period.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncfabriccircuits_service_dial_health_tmpl?indexName=ncfabriccircuits&aggInterval=3600000ms&timeZone=Africa/Abidjan&gte=now-24h&lte=now&size=0&aggTermSize=10&serviceId=d7840865-887a-4bca-a6e3-10c14bf7532c&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881

Response​

{"took":10,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":350,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"time_buckets":{"buckets":[{"key_as_string":"2025-12-11T16:45:00.000+05:30","key":1765451700000,"doc_count":11,"failure_causes":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"","doc_count":11}]}},{"key_as_string":"2025-12-11T16:50:00.000+05:30","key":1765452000000,"doc_count":30,"failure_causes":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"","doc_count":30}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncfabriccircuits)
aggIntervalstringYesFixed time interval for bucketing, e.g., 3600000ms, 5m, 1h, 1d
timeZonestringNoTime zone, e.g., Asia/Kolkata or America/New_York
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
serviceIdstringNoService ID
networkIdstringNoNetwork ID
networkGroupIdUUIDYesNetwork group ID

Network events (ncevents)​

Network event data. Includes API session events, router online/offline events, SDK events, and more.

ncevents_date_time_range_tmpl​

Get all network events within a date/time range.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncevents_date_time_range_tmpl?indexName=ncevents&networkGroupId=ac767028-f0dd-4c1e-ab68-3fb568873ec6&networkId=a7e42326-65e3-4adf-82bc-c2398250c59d&gte=now-24h&lte=now&size=500&componentName=&componentValue=

Response​

{"took":5,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":3,"failed":0},"hits":{"total":{"value":6,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncevents-2025.12.10-000940","_id":"wbSmDZsBuUGJIuNT7QE9","_score":null,"_source":{"@timestamp":"2025-12-11T13:43:21.975701608Z","resource_name":"MOP Ziti Metrics Processor Service(managed from 0ed768fa-7214-4404-8335-a715156dff45)","network_id":"697b4df6-d9da-4208-a3ee-777daf94190f","event_type":"deleted","network_name":"integrations test net","namespace":"edge.apiSessions"},"sort":[1765460601975]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncevents)
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
componentNamestringNoField to filter on: provider_instance_id, event_type, router_id, ip_address, nf_edge_router_id, nf_edge_router_name, network_name, or provider
componentValuestringNoCorresponding value for componentName
namespaceArray of stringNoNamespaces to include: fabric.routers, edge.apiSessions, sdk, cluster (URL-encoded JSON array)

ncevents_fabric_router_tmpl​

Get events for fabric routers.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncevents_fabric_router_tmpl?indexName=ncevents&networkGroupId=ac767028-f0dd-4c1e-ab68-3fb568873ec6&networkId=a7e42326-65e3-4adf-82bc-c2398250c59d&gte=now-72h&lte=now&size=100

Response​

{"took":3,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":2,"failed":0},"hits":{"total":{"value":8,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncevents-2025.12.08-000937","_id":"Bo4JB5sBcSbwYFP90qbn","_score":null,"_source":{"resource_name":"GCP_Upload_ER_1","event_type":"router-online","namespace":"fabric.routers","ip_address":"34.93.13.162","nf_edge_router_id":"97b195d0-5914-427d-b922-0611af769a18","nf_edge_router_name":"GCP_Upload_ER_1","network_id":"a9aba84c-5c87-4810-9572-8e29891a2a48","network_name":"NFTestNetwork1_10122025-060541","provider":"GCP","router_online":true},"sort":[1765349642881]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncevents)
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return

ncevents_filter_criteria_tmpl​

Get network events filtered by search criteria, such as event type or endpoint name.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncevents_filter_criteria_tmpl?indexName=ncevents&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&gte=1765265315505&lte=1765351715505&size=5000&eventType=&eventName=&eventSort=desc

Response​

{"took":4,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":2,"failed":0},"hits":{"total":{"value":6,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncevents-2025.12.10-000940","_id":"AZznDJsBcSbwYFP9HAWW","_score":null,"_source":{"nf_endpoint_id":"96d90268-c9bb-4075-b2e8-5cbcc9662a86","resource_name":"Test-Traffic","nf_endpoint_name":"Test-Traffic","network_id":"951eaaef-9d60-4db2-8401-c29dffcee637","network_name":"ChaosNet-V7","event_type":"sdk-online","namespace":"sdk"},"sort":[1765448031277]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncevents)
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
eventTypestringNoEvent type: created, deleted, leadership.gained, leadership.lost, router-offline, router-online, members.changed, sdk-offline, sdk-online
eventResourceTypestringNoCheck for the existence of a specific field (e.g., entity_type)
eventNamestringNoEndpoint name or wildcard search string
eventSortstringNoSort order (desc or asc)

ncevents_endpoint_last_seen_tmpl​

Provides the last seen timestamp of an endpoint.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncevents_endpoint_last_seen_tmpl?indexName=ncevents&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&gte=now-90d&lte=now&endpointId=649e3a27-d234-411c-ac00-76d146b52777&size=0

Response​

{"took":7,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":1,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"last_hit":{"hits":{"total":{"value":1,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncevents-2025.12.10-000940","_id":"Ps4jDpsBuUGJIuNTTvq0","_score":null,"_source":{"timestamp":"2025-12-11T15:59:00.391910204Z"},"sort":[1765468753484]}]}}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncevents)
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
gtestringYesStart of time range
ltestringYesEnd of time range
endpointIdUUIDYesEndpoint ID
sizeintegerYesNumber of documents to return

ncevents_all_tmpl​

Provides all network events without date filtering.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncevents_all_tmpl?indexName=ncevents&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&size=10000

Response​

{"took":7,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":98,"relation":"eq"},"max_score":57.702442,"hits":[{"_index":".ds-ncevents-2025.12.08-000937","_id":"juEj_5oBcSbwYFP9n6W5","_score":57.702442,"_source":{"nf_endpoint_id":"f2c6980d-3150-4082-8417-a8dbed16fab4","resource_name":"end-point-002","nf_endpoint_name":"end-point-002","network_id":"951eaaef-9d60-4db2-8401-c29dffcee637","network_name":"ChaosNet-V7","event_type":"sdk-online","namespace":"sdk"}}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncevents)
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
sizeintegerYesNumber of documents to return

Entity events (ncentityevent)​

Management (entity) events for a network. Includes provisioning, configuration changes, and deletion events from the NetFoundry console.

ncentityevent_events_tmpl​

Get all network entity events (management events) based on search criteria, such as event type or resource type.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncentityevent_events_tmpl?indexName=ncentityevent&gte=1765254248469&lte=1765340648469&size=5000&networkGroupId=ac767028-f0dd-4c1e-ab68-3fb568873ec6&networkId=a7e42326-65e3-4adf-82bc-c2398250c59d&networkEvent=&networkEventResourceType=&networkEventType=&networkEventSort=desc

Response​

{"took":10,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":2,"failed":0},"hits":{"total":{"value":163,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncentityevent-2025-2025.12.10-000508","_id":"V5UiDZsBuUGJIuNTWeuZ","_score":null,"_source":{"eventType":"Deleted","eventSource":"MOP","Timestamp":"2025-12-11T11:18:33.460Z","componentType":"Network","resourceType":"Network","componentName":"NFTestNetwork1_11122025-060525","resourceId":"b4ba7607-a507-4004-82dc-7a5e7cd11d04","network_id":"b4ba7607-a507-4004-82dc-7a5e7cd11d04","networkGroupId":"6d03edd7-c6c9-4279-a7c5-054bde581881","eventSeverity":"Info","eventDescription":"Network deleted successfully."},"sort":[1765451913520]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncentityevent)
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
networkEventstringNoFilter on any document field, e.g., eventType, eventSource, resourceType
networkEventResourceTypestringNoResource type: Network, ControllerNetwork, Edge Router, Host, Service, Endpoint, AppWan, Authentication Policy, Edge Router Policy, clientsync, BrowZer Application, External JWT Signer
networkEventTypestringNoEvent type: Provisioned, Changed, Deleted, log, Error, Info, New
networkEventSortstringNoSort order (desc or asc)

ncentityevent_dashboard_events_tmpl​

Get all network entity events (management events) based on search criteria, such as resource ID, endpoint ID, or endpoint name.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncentityevent_dashboard_events_tmpl?indexName=ncentityevent&gte=1765266113990&lte=1765352513990&size=100&networkGroupId=6d03edd7-c6c9-4279-a7c5-054bde581881&networkId=a9aba84c-5c87-4810-9572-8e29891a2a48&resourceId=&endpointId=&edgeRouterId=&queryString=&endpointName=

Response​

{"took":105,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":2,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncentityevent-2025-2025.12.08-000505","_id":"nywmB5sBuUGJIuNTRa0h","_score":null,"_source":{"eventType":"Changed","Timestamp":"2025-12-10T07:25:07.060Z","eventSeverity":"Info","eventSource":"MOP","componentType":"Endpoint","networkGroupId":"6d03edd7-c6c9-4279-a7c5-054bde581881","networkId":"a9aba84c-5c87-4810-9572-8e29891a2a48","resourceId":"fd1cfe7b-23ad-4a9c-ac7a-2deb4ef22c6a","resourceType":"Endpoint","componentName":"ReName_Identitie210122025-072501","eventDescription":"Endpoint updated successfully."},"sort":[1765351507129]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncentityevent)
gtelong (epoch_milli)YesStart of time range
ltelong (epoch_milli)YesEnd of time range
sizeintegerYesNumber of documents to return
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
resourceIdUUIDNoResource ID (network, controller, edge router, host, service, endpoint, AppWan, etc.)
componentIdUUIDNoSame as endpoint ID or edge router ID
endpointIdUUIDNoEndpoint ID
edgeRouterIdUUIDNoEdge router ID
queryStringstringNoQuery for any document field value
endpointNamestringNoEndpoint name

ncentityevent_all_events_tmpl​

Get all network events with optional filter criteria.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncentityevent_all_events_tmpl?indexName=ncentityevent&gte=now-24h&lte=now&size=10000&networkGroupId=ac767028-f0dd-4c1e-ab68-3fb568873ec6&networkId=a7e42326-65e3-4adf-82bc-c2398250c59d&networkEventResourceType=&networkEventType=&networkEventSort=desc

Response​

{"took":10,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":2,"failed":0},"hits":{"total":{"value":163,"relation":"eq"},"max_score":null,"hits":[{"_index":".ds-ncentityevent-2025-2025.12.10-000508","_id":"V5UiDZsBuUGJIuNTWeuZ","_score":null,"_source":{"eventType":"Deleted","eventSource":"MOP","Timestamp":"2025-12-11T11:18:33.460Z","componentType":"Network","resourceType":"Network","componentName":"NFTestNetwork1_11122025-060525","resourceId":"b4ba7607-a507-4004-82dc-7a5e7cd11d04","eventSeverity":"Info","eventDescription":"Network deleted successfully."},"sort":[1765451913520]}]}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (ncentityevent)
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
networkEventResourceTypestringNoResource type: Network, ControllerNetwork, Edge Router, Host, Service, Endpoint, AppWan, Authentication Policy, Edge Router Policy, clientsync, BrowZer Application, External JWT Signer
networkEventTypestringNoEvent type: Provisioned, Changed, Deleted, log, Error, Info, New
networkEventSortstringNoSort order (desc or asc)

Fabric link latency data for a network. Includes timeout data, latency trends, and historical aggregations.

nclinklatency_timeouts_data_query_tmpl​

Provides timeout data for a network.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/nclinklatency_timeouts_data_query_tmpl?gte=2025-12-09T18:30:00.000Z&lte=2025-12-10T18:29:59.999Z&size=5000&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&indexName=nclinklatency&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0

Response​

{"took":20,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":3,"failed":0},"hits":{"max_score":null,"hits":[{"_index":".ds-nclinklatency-2025.12.10-000655","_id":"Mrd6DZsBcSbwYFP9Rtal","_version":1,"_score":null,"fields":{"nf_source_edge_router_name":["private-staging-ZTNA"],"nf_destination_edge_router_name":["private-staging-ZTNA"],"max":[8888888888888],"timestamp":["2025-12-11T12:54:33.400Z"]},"sort":["private-staging-ZTNA","private-staging-ZTNA",1765457673400]}]}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
networkIdUUIDYesNetwork ID
indexNamestringYesIndex name (nclinklatency)
networkGroupIdUUIDYesNetwork group ID

nclinklatency_fabric_latency_tmpl​

Groups events into fixed time intervals and returns the maximum latency for each interval.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/nclinklatency_fabric_latency_tmpl?gte=2025-12-09T18:30:00Z&lte=2025-12-10T07:15:43Z&size=0&aggTermSize=500&interval=1h&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&resourceId=zRqdAyvMn&dayFilterMin=2025-12-09T18:30:00Z&dayFilterMax=2025-12-10T07:15:43Z&latencyType=p99&indexName=nclinklatency

Response​

{"took":93,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":8888,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"links":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"4TwEchMbrGtAhfiueEDpzD","doc_count":2222,"source_routers":{"buckets":[{"key":"private-sandbox-ZTNA","doc_count":2222,"destination_routers":{"buckets":[{"key":"public us-east-1 (DO NOT DELETE)","doc_count":2222,"intervals":{"buckets":[{"key_as_string":"2025-12-10T18:00:00.000Z","key":1765389600000,"doc_count":60,"latency":{"value":3117181.25}}]}}]}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top links (aggregated by link ID) to return
intervalstringYesFixed time duration for grouping events, e.g., 1h
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
resourceIdstringYesEdge router ID
dayFilterMinstringYesStart of day filter range
dayFilterMaxstringYesEnd of day filter range
latencyTypestringNoLatency percentile: p50, p75, p95, p99, p999, p9999, Max, or Mean
indexNamestringYesIndex name (nclinklatency)

nclinklatency_timeouts_daily_interval_tmpl​

Get all link latency data based on a calendar interval.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/nclinklatency_timeouts_daily_interval_tmpl?size=0&timeZone=UTC&calenderInterval=1d&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&indexName=nclinklatency&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0

Response​

{"took":30,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":null,"hits":[]},"aggregations":{"time_buckets":{"buckets":[{"key_as_string":"2025-12-04T00:00:00.000Z","key":1764806400000,"doc_count":78408},{"key_as_string":"2025-12-05T00:00:00.000Z","key":1764892800000,"doc_count":95040},{"key_as_string":"2025-12-06T00:00:00.000Z","key":1764979200000,"doc_count":95091},{"key_as_string":"2025-12-11T00:00:00.000Z","key":1765411200000,"doc_count":50829}]}}}

Query parameters​

ParameterTypeRequiredDescription
sizeintegerYesNumber of documents to return
timeZonestringNoTime zone (e.g., UTC)
calenderIntervalstringYesCalendar interval: 1d (daily), 1w (weekly), 1M (monthly), 1y (yearly)
networkIdUUIDYesNetwork ID
indexNamestringYesIndex name (nclinklatency)
networkGroupIdUUIDYesNetwork group ID

nclinklatency_fabric_latency_v8_tmpl​

For V8 networks, groups fabric latency into fixed time intervals and returns the maximum latency for each interval.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/nclinklatency_fabric_latency_v8_tmpl?gte=2025-12-09T05:00:00Z&lte=2025-12-09T20:39:53Z&size=0&aggTermSize=500&interval=1h&networkGroupId=99dcc777-a206-4085-b853-04dbfab4ecce&networkId=cdf8f1c7-07f2-7777-8672-ed2b683d43f4&resourceId=abcd&dayFilterMin=2025-12-09T05:00:00Z&dayFilterMax=2025-12-09T20:39:53Z&latencyType=mean&indexName=nclinklatency

Response​

{"took":103,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":6707,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"links":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"7eLN0XlKXrqakYBkdMHVl2","doc_count":2235,"source_routers":{"buckets":[{"key":"public us-east-1","doc_count":2235,"destination_routers":{"buckets":[{"key":"public us-east-1-wss","doc_count":2235,"intervals":{"buckets":[{"key_as_string":"2025-12-10T18:00:00.000Z","key":1765389600000,"doc_count":60,"latency":{"value":3218217.75}}]}}]}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
sizeintegerYesNumber of documents to return
aggTermSizeintegerYesNumber of top links (aggregated by link ID) to return
intervalstringYesFixed time duration for grouping events, e.g., 1h
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
resourceIdstringNoEdge router ID
dayFilterMinstringYesStart of day filter range
dayFilterMaxstringYesEnd of day filter range
latencyTypestringNoLatency percentile: p50, p75, p95, p99, p999, p9999, Max, or Mean
indexNamestringYesIndex name (nclinklatency)

nclinklatency_timeouts_date_filter_tmpl​

Get network link latency timeout data with source and destination router aggregations.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/nclinklatency_timeouts_date_filter_tmpl?indexName=nclinklatency&size=1000&timeZone=UTC&gte=2025-12-09T18:30:00.000Z&lte=2025-12-10T18:29:59.999Z&aggTermSize=10&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0

Response​

{"took":62,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":10000,"relation":"gte"},"max_score":0,"hits":[{"_index":".ds-nclinklatency-2025.12.10-000655","_score":0,"_source":{"timestamp":"2025-12-11T12:49:43.143Z","p99":200736306.53,"count":476302,"metric":"link.latency","nf_source_edge_router_name":"test-edge-router","nf_destination_edge_router_name":"public us-east-1 (DO NOT DELETE)","network_id":"951eaaef-9d60-4db2-8401-c29dffcee637","network_name":"ChaosNet-V7"}}]},"aggregations":{"time_buckets":{"buckets":[{"key_as_string":"2025-12-10T18:00:00.000Z","key":1765389600000,"doc_count":1500,"source_routers":{"buckets":[{"key":"test-edge-router","doc_count":120,"destination_routers":{"buckets":[{"key":"public us-east-1 (DO NOT DELETE)","doc_count":60,"avg_of":{"value":194386203.8}}]}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
indexNamestringYesIndex name (nclinklatency)
sizeintegerYesNumber of documents to return
timeZonestringNoTime zone (e.g., UTC)
gtestringYesStart of time range
ltestringYesEnd of time range
aggTermSizeintegerYesNumber of top source/destination routers to return
networkIdUUIDYesNetwork ID
networkGroupIdUUIDYesNetwork group ID

Controller latency (ncctrllatency)​

Controller latency data for a network.

ncctrllatency_controller_latency_tmpl​

Get controller latency over time.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncctrllatency_controller_latency_tmpl?gte=2025-12-09T18:30:00Z&lte=2025-12-10T07:27:31Z&interval=1h&networkGroupId=fa080396-8f02-4596-9bf4-d16e1686b4b0&networkId=951eaaef-9d60-4db2-8401-c29dffcee637&latencyType=mean&indexName=ncctrllatency

Response​

{"took":29,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":8800,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"time_buckets":{"buckets":[{"key_as_string":"2025-12-10T18:00:00.000Z","key":1765389600000,"doc_count":240,"routers":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"test-edge-router","doc_count":30,"avg_of":{"value":188954487.46666667}},{"key":"public us-east-1 (DO NOT DELETE)","doc_count":30,"avg_of":{"value":3224196.691666667}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
intervalstringYesFixed time duration for grouping events, e.g., 1h
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
latencyTypestringNoLatency percentile: p99, p999, p9999, Max, or Mean
indexNamestringYesIndex name (ncctrllatency)

ncctrllatency_controller_latency_v8_tmpl​

Get controller latency over time for V8 networks.

Request​

GET https://gateway.staging.netfoundry.io/reporting/v1/template-search/ncctrllatency_controller_latency_v8_tmpl?gte=2025-12-07T23:00:00Z&lte=2025-12-08T12:59:06Z&interval=1h&networkGroupId=19e51046-53d8-1111-8305-c8a5083c8487&networkId=58fe07ac-35bf-4de5-1111-2ac02d234193&latencyType=mean&indexName=ncctrllatency

Response​

{"took":20,"timed_out":false,"_shards":{"total":4,"successful":4,"skipped":0,"failed":0},"hits":{"total":{"value":4512,"relation":"eq"},"max_score":null,"hits":[]},"aggregations":{"time_buckets":{"buckets":[{"key_as_string":"2025-12-10T18:00:00.000Z","key":1765389600000,"doc_count":120,"routers":{"doc_count_error_upper_bound":0,"sum_other_doc_count":0,"buckets":[{"key":"test-events-for-er","doc_count":30,"avg_of":{"value":193728994.66666666}},{"key":"public us-east-1","doc_count":30,"avg_of":{"value":83742442.66666667}}]}}]}}}

Query parameters​

ParameterTypeRequiredDescription
gtestringYesStart of time range
ltestringYesEnd of time range
intervalstringYesFixed time duration for grouping events, e.g., 1h
networkGroupIdUUIDYesNetwork group ID
networkIdUUIDYesNetwork ID
latencyTypestringNoLatency percentile: p99, p999, p9999, Max, or Mean
indexNamestringYesIndex name (ncctrllatency)