Generated by API Evangelist
Written by API Evangelist tooling for Hubble Network's API. It is a proposal applied on top of the contract, not a document Hubble Network publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Hubble Platform Platform Metrics API
version: 1.0.0
extends: openapi/hubble-network-platform-metrics-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/v1/org/{org_id}/api_metrics'].get
update:
x-apievangelist-phrasing:
intent: View API request metrics
effect: read
questions:
- How many API requests has my organization made, and what's the success rate?
- Can I break down my API call volume by hour or day?
instructions:
- text: Show API request metrics for organization {org_id} over the last {days} days.
slots:
org_id: path.org_id
days: query.days
- text: Break down org {org_id}'s API call success rate by {time_interval}.
slots:
org_id: path.org_id
time_interval: query.time_interval
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/packet_metrics'].get
update:
x-apievangelist-phrasing:
intent: View packet volume metrics
effect: read
questions:
- How many packets have my devices delivered over the past week?
- Can I see packet totals for production devices only?
instructions:
- text: Show packet metrics for organization {org_id} over the last {days} days.
slots:
org_id: path.org_id
days: query.days
- text: Chart packet counts for org {org_id} by {time_interval} for devices tagged {filter_tags}.
slots:
org_id: path.org_id
time_interval: query.time_interval
filter_tags: query.filter_tags
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/webhook_metrics'].get
update:
x-apievangelist-phrasing:
intent: View webhook delivery metrics
effect: read
questions:
- What's the success rate of webhook deliveries to my endpoints?
- How many webhook requests went out to us each day recently?
instructions:
- text: Show webhook delivery metrics for organization {org_id} over the last {days} days.
slots:
org_id: path.org_id
days: query.days
- text: Break down org {org_id}'s webhook success rate by {time_interval}.
slots:
org_id: path.org_id
time_interval: query.time_interval
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/org/{org_id}/device_metrics'].get
update:
x-apievangelist-phrasing:
intent: Track active and registered device counts
effect: read
questions:
- How many of my registered devices have never been active?
- How has the number of active devices changed over time?
instructions:
- text: Show active, never-active and registered device counts for org {org_id} over {days} days.
slots:
org_id: path.org_id
days: query.days
- text: Trend active device counts for org {org_id} by {time_interval} for platform tag {filter_tags}.
slots:
org_id: path.org_id
time_interval: query.time_interval
filter_tags: query.filter_tags
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.