New Relic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for New Relic Applications API

22 actions 22 updates phrasing extends openapi/new-relic-applications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for New Relic's API. It is a proposal applied on top of the contract, not a document New Relic publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 22 · first 16 shown; the file carries all of them

$.info
$.paths['/applications.json'].get
$.paths['/applications/{application_id}/deployments.json'].get
$.paths['/applications/{application_id}/deployments.json'].post
$.paths['/applications/{application_id}/deployments/{id}.json'].delete
$.paths['/applications/{application_id}/hosts.json'].get
$.paths['/applications/{application_id}/hosts/{host_id}/metrics.json'].get
$.paths['/applications/{application_id}/hosts/{host_id}/metrics/data.json'].get
$.paths['/applications/{application_id}/hosts/{id}.json'].get
$.paths['/applications/{application_id}/instances.json'].get
$.paths['/applications/{application_id}/instances/{id}.json'].get
$.paths['/applications/{application_id}/instances/{instance_id}/metrics.json'].get
$.paths['/applications/{application_id}/instances/{instance_id}/metrics/data.json'].get
$.paths['/applications/{application_id}/metrics.json'].get
$.paths['/applications/{application_id}/metrics/data.json'].get
$.paths['/applications/{id}.json'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for New Relic Applications API
  version: 1.0.0
extends: openapi/new-relic-applications-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 21
- target: $.paths['/applications.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List APM applications
      effect: read
      questions:
      - Which APM applications are reporting to my New Relic account?
      - Can I filter my applications by language, like only Java or only Node apps?
      - What's the health status and response time of each of my applications?
      instructions:
      - text: List all my APM applications.
      - text: Find applications whose name matches {name}.
        slots:
          name: query.filter[name]
      - text: List the {language} applications running on host {host}.
        slots:
          language: query.filter[language]
          host: query.filter[host]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/deployments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's deployment history
      effect: read
      questions:
      - When was an application last deployed, and what revision went out?
      - Can I see the full history of deployment markers recorded for one app?
      instructions:
      - text: List the deployments recorded for application {application_id}.
        slots:
          application_id: path.application_id
      - text: Show page {page} of deployment history for app {application_id}.
        slots:
          page: query.page
          application_id: path.application_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/deployments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a deployment marker for an application
      effect: write
      questions:
      - How do I mark a release on my application's performance charts?
      - Can my CI pipeline record a deployment so I can correlate it with a change in errors?
      instructions:
      - text: Record a new deployment marker for application {application_id}.
        slots:
          application_id: path.application_id
      - text: Log a deploy event on app {application_id} so it shows on the charts.
        slots:
          application_id: path.application_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/deployments/{id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment marker
      effect: destructive
      questions:
      - Can I remove a deployment marker I recorded by mistake?
      - How do I delete one deployment record from an application's history?
      instructions:
      - text: Delete deployment {id} from application {application_id}.
        slots:
          id: path.id
          application_id: path.application_id
      - text: Remove the mistaken deployment marker {id} on app {application_id}.
        slots:
          id: path.id
          application_id: path.application_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/hosts.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the hosts running an application
      effect: read
      questions:
      - Which servers is one of my applications running on?
      - Can I filter an application's hosts by hostname?
      instructions:
      - text: List the hosts running application {application_id}.
        slots:
          application_id: path.application_id
      - text: Find hosts named {hostname} for app {application_id}.
        slots:
          hostname: query.filter[hostname]
          application_id: path.application_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/hosts/{host_id}/metrics.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric names for an application host
      effect: read
      questions:
      - What metric names are available for one host of an application?
      - Which metrics can I query for a specific server running my app?
      instructions:
      - text: List the metric names available for host {host_id} of application {application_id}.
        slots:
          host_id: path.host_id
          application_id: path.application_id
      - text: Find host {host_id} metric names containing {name} for app {application_id}.
        slots:
          host_id: path.host_id
          name: query.name
          application_id: path.application_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/hosts/{host_id}/metrics/data.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metric values for an application host
      effect: read
      questions:
      - What was the response time on one specific host of my app over the last hour?
      - Can I get summarized metric values for a single application host over a time range?
      instructions:
      - text: Get {names} metric data for host {host_id} of application {application_id}.
        slots:
          names: query.names
          host_id: path.host_id
          application_id: path.application_id
      - text: Fetch host {host_id} values for {names} on app {application_id} from {from} to {to}.
        slots:
          host_id: path.host_id
          names: query.names
          application_id: path.application_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/hosts/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one host of an application
      effect: read
      questions:
      - How is one particular server running my application performing?
      - What details does New Relic keep about a single application host?
      instructions:
      - text: Show details for host {id} of application {application_id}.
        slots:
          id: path.id
          application_id: path.application_id
      - text: Get the summary for app {application_id} on host {id}.
        slots:
          application_id: path.application_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/instances.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's instances
      effect: read
      questions:
      - How many instances of my application are running right now?
      - Can I filter an application's instances by the server they run on?
      instructions:
      - text: List the instances of application {application_id}.
        slots:
          application_id: path.application_id
      - text: Show instances of app {application_id} on server {hostname}.
        slots:
          application_id: path.application_id
          hostname: query.filter[hostname]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/instances/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one application instance
      effect: read
      questions:
      - How is a single instance of my application doing over the last few minutes?
      - What summary data is there for one specific app instance?
      instructions:
      - text: Show instance {id} of application {application_id}.
        slots:
          id: path.id
          application_id: path.application_id
      - text: Get the recent summary for app {application_id} instance {id}.
        slots:
          application_id: path.application_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/instances/{instance_id}/metrics.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric names for an application instance
      effect: read
      questions:
      - Which metric names can I query for one application instance?
      - What metrics does a single instance of my app report?
      instructions:
      - text: List the metric names for instance {instance_id} of application {application_id}.
        slots:
          instance_id: path.instance_id
          application_id: path.application_id
      - text: Find instance {instance_id} metric names matching {name} in app {application_id}.
        slots:
          instance_id: path.instance_id
          name: query.name
          application_id: path.application_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/instances/{instance_id}/metrics/data.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metric values for an application instance
      effect: read
      questions:
      - What was the throughput of one application instance during an incident window?
      - Can I pull raw metric values for a single app instance?
      instructions:
      - text: Get {names} metric data for instance {instance_id} of application {application_id}.
        slots:
          names: query.names
          instance_id: path.instance_id
          application_id: path.application_id
      - text: Fetch instance {instance_id} values for {names} in app {application_id} from {from} to {to}.
        slots:
          instance_id: path.instance_id
          names: query.names
          application_id: path.application_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/metrics.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric names for an application
      effect: read
      questions:
      - What metric names does my application report across all its hosts?
      - Which application-wide metrics and value names can I query?
      instructions:
      - text: List the metric names reported by application {application_id}.
        slots:
          application_id: path.application_id
      - text: Find application-level metric names matching {name} for app {application_id}.
        slots:
          name: query.name
          application_id: path.application_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application_id}/metrics/data.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metric values for an application
      effect: read
      questions:
      - What were my application's app-wide metric values yesterday?
      - Can I get application-wide metric data summarized into a single value?
      instructions:
      - text: Get {names} metric data for application {application_id}.
        slots:
          names: query.names
          application_id: path.application_id
      - text: Fetch app-wide {names} values for application {application_id} from {from} to {to}.
        slots:
          names: query.names
          application_id: path.application_id
          from: query.from
          to: query.to
      - text: Summarize {names} for application {application_id} into one value with summarize {summarize}.
        slots:
          names: query.names
          application_id: path.application_id
          summarize: query.summarize
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an APM application
      effect: read
      questions:
      - What's the current health and summary of one of my APM applications?
      - How is a specific application performing over the last few minutes?
      instructions:
      - text: Show application {id}.
        slots:
          id: path.id
      - text: Get the health status and summary data for app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an APM application's settings
      effect: write
      questions:
      - Can I change the settings of an existing APM application?
      - What happens to extra fields I send when updating an application?
      instructions:
      - text: Update the settings of application {id}.
        slots:
          id: path.id
      - text: Apply new settings to APM app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an application and its data
      effect: destructive
      questions:
      - How do I delete an old application that stopped reporting?
      - Is deleting an application and all of its reported data reversible?
      instructions:
      - text: Delete application {id} and all its reported data.
        slots:
          id: path.id
      - text: Permanently remove the stopped application {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mobile_applications.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List mobile applications
      effect: read
      questions:
      - Which mobile apps are reporting to my New Relic account?
      - What mobile applications are being monitored on my account?
      instructions:
      - text: List all my mobile applications.
      - text: Show every monitored mobile app on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mobile_applications/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a mobile application
      effect: read
      questions:
      - How has one of my mobile apps been doing over the last 30 minutes?
      - What summary data is there for a single mobile application?
      instructions:
      - text: Show mobile application {id}.
        slots:
          id: path.id
      - text: Get the last 30 minutes of summary data for mobile app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mobile_applications/{mobile_application_id}/metrics.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric names for a mobile application
      effect: read
      questions:
      - What metric names can I query for my mobile app?
      - Which metrics does a mobile application report?
      instructions:
      - text: List the metric names for mobile application {mobile_application_id}.
        slots:
          mobile_application_id: path.mobile_application_id
      - text: Find mobile app {mobile_application_id} metric names matching {name}.
        slots:
          mobile_application_id: path.mobile_application_id
          name: query.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mobile_applications/{mobile_application_id}/metrics/data.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metric values for a mobile application
      effect: read
      questions:
      - How did a metric for my mobile app trend over the past day?
      - Can I get mobile app metric values for a specific time range?
      instructions:
      - text: Get {names} metric data for mobile application {mobile_application_id}.
        slots:
          names: query.names
          mobile_application_id: path.mobile_application_id
      - text: Fetch mobile app {mobile_application_id} values for {names} from {from} to {to}.
        slots:
          mobile_application_id: path.mobile_application_id
          names: query.names
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'