Traffic analytics
Traffic sources and properties, HTTP reports and the audience overview built from access logs. Generated from the `notploy` command surface.
Traffic sources and properties, HTTP reports and the audience overview built from access logs.
notploy traffic exposes 11 commands. They map one-to-one onto the traffic.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy traffic --help to list these commands in your terminal, or
notploy traffic <command> --help for a single command.
Commands
notploy traffic audience
Calls GET /api/trpc/traffic.audience.
notploy traffic audience [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--preset <value> | string | No | 1h, 24h, 7d, 30d, custom |
--from <value> | string | No | — |
--to <value> | string | No | — |
--propertyIds <json> | array | No | — |
--platform <value> | string | No | — |
--limit <value> | number | No | — |
--profile <name> | string | No | — |
notploy traffic collect-now
Calls POST /api/trpc/traffic.collectNow.
notploy traffic collect-now [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy traffic create-property
Calls POST /api/trpc/traffic.createProperty.
notploy traffic create-property --platform <value> --domain <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--platform <value> | string | Yes | — |
--name <value> | string | No | — |
--domain <value> | string | Yes | — |
--matchesSubdomains [boolean] | boolean | No | — |
--no-matchesSubdomains | boolean | No | — |
--sourceType <value> | string | No | traefik, web-instrumentation, external |
--logPath <value> | string | No | — |
--allowedOrigins <json> | array | No | — |
--profile <name> | string | No | — |
notploy traffic declare-recommended
Calls POST /api/trpc/traffic.declareRecommended.
notploy traffic declare-recommended [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy traffic delete-property
Calls POST /api/trpc/traffic.deleteProperty.
notploy traffic delete-property --propertyId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--propertyId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy traffic http
Calls GET /api/trpc/traffic.http.
notploy traffic http [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--preset <value> | string | No | 1h, 24h, 7d, 30d, custom |
--from <value> | string | No | — |
--to <value> | string | No | — |
--propertyIds <json> | array | No | — |
--platform <value> | string | No | — |
--limit <value> | number | No | — |
--profile <name> | string | No | — |
notploy traffic overview
Calls GET /api/trpc/traffic.overview.
notploy traffic overview [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--preset <value> | string | No | 1h, 24h, 7d, 30d, custom |
--from <value> | string | No | — |
--to <value> | string | No | — |
--propertyIds <json> | array | No | — |
--platform <value> | string | No | — |
--compare [boolean] | boolean | No | — |
--no-compare | boolean | No | — |
--profile <name> | string | No | — |
notploy traffic properties
Calls GET /api/trpc/traffic.properties.
notploy traffic properties [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy traffic timeseries
Calls GET /api/trpc/traffic.timeseries.
notploy traffic timeseries [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--preset <value> | string | No | 1h, 24h, 7d, 30d, custom |
--from <value> | string | No | — |
--to <value> | string | No | — |
--propertyIds <json> | array | No | — |
--platform <value> | string | No | — |
--includeHttp [boolean] | boolean | No | — |
--no-includeHttp | boolean | No | — |
--includeAudience [boolean] | boolean | No | — |
--no-includeAudience | boolean | No | — |
--profile <name> | string | No | — |
notploy traffic update-property
Calls POST /api/trpc/traffic.updateProperty.
notploy traffic update-property --propertyId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--propertyId <value> | string | Yes | — |
--name <value> | string | No | — |
--platform <value> | string | No | — |
--matchesSubdomains [boolean] | boolean | No | — |
--no-matchesSubdomains | boolean | No | — |
--enabled [boolean] | boolean | No | — |
--no-enabled | boolean | No | — |
--profile <name> | string | No | — |
notploy traffic upsert-source
Calls POST /api/trpc/traffic.upsertSource.
notploy traffic upsert-source --propertyId <value> --type <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--propertyId <value> | string | Yes | — |
--type <value> | string | Yes | traefik, web-instrumentation, external |
--enabled [boolean] | boolean | No | — |
--no-enabled | boolean | No | — |
--logPath <value> | string | No | — |
--allowedOrigins <json> | array | No | — |
--rotatePublicKey [boolean] | boolean | No | — |
--no-rotatePublicKey | boolean | No | — |
--profile <name> | string | No | — |