Acquia · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Acquia Cloud API Documentation Applications API
48 actions
48 updates
phrasing
extends
openapi/acquia-applications-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Acquia's API. It is a proposal applied on top of the contract, not a document Acquia publishes.
What the actions change
x-apievangelist-phrasing
Targets 48 · first 16 shown; the file carries all of them
$.info
$.paths['/applications'].get
$.paths['/applications/{applicationUuid}'].get
$.paths['/applications/{applicationUuid}'].put
$.paths['/applications/{applicationUuid}/artifacts'].get
$.paths['/applications/{applicationUuid}/artifacts/{artifactId}'].get
$.paths['/applications/{applicationUuid}/code'].get
$.paths['/applications/{applicationUuid}/code-studio'].get
$.paths['/applications/{applicationUuid}/code-studio'].post
$.paths['/applications/{applicationUuid}/code-studio'].delete
$.paths['/applications/{applicationUuid}/databases'].get
$.paths['/applications/{applicationUuid}/databases'].post
$.paths['/applications/{applicationUuid}/databases/{name}'].delete
$.paths['/applications/{applicationUuid}/databases/{name}/actions/erase'].post
$.paths['/applications/{applicationUuid}/email/domains'].get
$.paths['/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Acquia Cloud API Documentation Applications API
version: 1.0.0
extends: openapi/acquia-applications-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: 47
- target: $.paths['/applications'].get
update:
x-apievangelist-phrasing:
intent: List the applications I can access
effect: read
questions:
- Which Acquia applications do I have access to through my teams?
- Can I page through all of my Cloud Platform applications sorted by name?
instructions:
- text: List every application I have access to.
- text: Show my applications matching {filter}, {limit} at a time.
slots:
filter: query.filter
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}'].get
update:
x-apievangelist-phrasing:
intent: Get details of one application
effect: read
questions:
- What details can I see about a single hosted application?
- How do I look up one application by its UUID?
instructions:
- text: Show me the details of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Fetch the record for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}'].put
update:
x-apievangelist-phrasing:
intent: Rename an application
effect: write
questions:
- Can I change the display name of an existing application?
- How do I rename one of my hosted applications?
instructions:
- text: Rename application {applicationUuid} to {name}.
slots:
applicationUuid: path.applicationUuid
name: requestBody.name
- text: Give application {applicationUuid} the new name {name}.
slots:
applicationUuid: path.applicationUuid
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/artifacts'].get
update:
x-apievangelist-phrasing:
intent: List build artifacts for a Node.js application
effect: read
questions:
- Where can I see the build artifacts produced for my Node.js application?
- Can I sort a Node.js app's build artifacts by creation date?
instructions:
- text: List the build artifacts for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show build artifacts of application {applicationUuid} sorted by {sort}.
slots:
applicationUuid: path.applicationUuid
sort: query.sort
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/artifacts/{artifactId}'].get
update:
x-apievangelist-phrasing:
intent: Get one build artifact of an application
effect: read
questions:
- What information is kept about a single build artifact?
- Can I inspect one specific artifact from a Node.js app build?
instructions:
- text: Show build artifact {artifactId} of application {applicationUuid}.
slots:
artifactId: path.artifactId
applicationUuid: path.applicationUuid
- text: Get the details of artifact {artifactId} in application {applicationUuid}.
slots:
artifactId: path.artifactId
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/code'].get
update:
x-apievangelist-phrasing:
intent: List an application's branches and release tags
effect: read
questions:
- Which git branches and release tags exist in my application's repository?
- Can I filter my application's branches and tags by name?
instructions:
- text: List the branches and tags in application {applicationUuid}'s repository.
slots:
applicationUuid: path.applicationUuid
- text: Find branches or tags in application {applicationUuid} matching {filter}.
slots:
applicationUuid: path.applicationUuid
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/code-studio'].get
update:
x-apievangelist-phrasing:
intent: Get an application's Code Studio project
effect: read
questions:
- Does my application already have a Code Studio project set up?
- What does the Code Studio project for an application look like?
instructions:
- text: Show the Code Studio project for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Check the Code Studio project details of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/code-studio'].post
update:
x-apievangelist-phrasing:
intent: Create a Code Studio project for an application
effect: write
questions:
- How do I set up Code Studio for one of my applications?
- Can I create a Code Studio project for an application that doesn't have one?
instructions:
- text: Create a Code Studio project for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Set up Code Studio on application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/code-studio'].delete
update:
x-apievangelist-phrasing:
intent: Remove an application's Code Studio project
effect: destructive
questions:
- Can I remove Code Studio from an application I no longer build there?
- What happens when I take the Code Studio project off an application?
instructions:
- text: Remove the Code Studio project from application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Tear down Code Studio for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/databases'].get
update:
x-apievangelist-phrasing:
intent: List an application's database names
effect: read
questions:
- What databases does my application have?
- Can I filter an application's database list by name?
instructions:
- text: List the database names for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show databases in application {applicationUuid} matching {filter}.
slots:
applicationUuid: path.applicationUuid
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/databases'].post
update:
x-apievangelist-phrasing:
intent: Create a database across all environments
effect: write
questions:
- How do I add a new database to every environment of my application?
- Does creating a database add it to dev, stage and prod at once?
instructions:
- text: Create a database named {name} in application {applicationUuid}.
slots:
name: requestBody.name
applicationUuid: path.applicationUuid
- text: Add database {name} to all environments of application {applicationUuid}.
slots:
name: requestBody.name
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/databases/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Drop a database from every environment
effect: destructive
questions:
- Can I drop a database entirely from my application?
- Will deleting a database remove it from all environments, not just one?
instructions:
- text: Drop database {name} from application {applicationUuid}.
slots:
name: path.name
applicationUuid: path.applicationUuid
- text: Delete the {name} database in every environment of application {applicationUuid}.
slots:
name: path.name
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/databases/{name}/actions/erase'].post
update:
x-apievangelist-phrasing:
intent: Truncate all tables in a database
effect: destructive
questions:
- How can I wipe every table in a database but keep the database itself?
- Does erasing a database clear its tables in all environments?
instructions:
- text: Erase all tables in database {name} of application {applicationUuid}.
slots:
name: path.name
applicationUuid: path.applicationUuid
- text: Truncate the {name} database across application {applicationUuid}'s environments.
slots:
name: path.name
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/email/domains'].get
update:
x-apievangelist-phrasing:
intent: List email domains available to an application
effect: read
questions:
- Which email sending domains are associated with my application?
- Can I see the subscription-verified email domains my app could use?
instructions:
- text: List the email domains for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show email domains of application {applicationUuid} matching {filter}.
slots:
applicationUuid: path.applicationUuid
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/associate'].post
update:
x-apievangelist-phrasing:
intent: Associate an email domain with an application
effect: write
questions:
- How do I let my application send email from a registered domain?
- Can I attach a verified email domain to a specific application?
instructions:
- text: Associate email domain {domainRegistrationUuid} with application {applicationUuid}.
slots:
domainRegistrationUuid: path.domainRegistrationUuid
applicationUuid: path.applicationUuid
- text: Link domain registration {domainRegistrationUuid} to application {applicationUuid} for Platform Email.
slots:
domainRegistrationUuid: path.domainRegistrationUuid
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/email/domains/{domainRegistrationUuid}/actions/disassociate'].post
update:
x-apievangelist-phrasing:
intent: Detach an email domain from an application
effect: write
questions:
- Can I stop an application from using a particular email domain?
- How do I unlink an email domain from one of my apps?
instructions:
- text: Disassociate email domain {domainRegistrationUuid} from application {applicationUuid}.
slots:
domainRegistrationUuid: path.domainRegistrationUuid
applicationUuid: path.applicationUuid
- text: Unlink domain registration {domainRegistrationUuid} from application {applicationUuid}.
slots:
domainRegistrationUuid: path.domainRegistrationUuid
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/ides'].get
update:
x-apievangelist-phrasing:
intent: List Cloud IDEs for an application
effect: read
questions:
- Which Cloud IDEs have been created for this application?
- Who on my team has a Cloud IDE tied to this app?
instructions:
- text: List the Cloud IDEs attached to application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show all IDEs provisioned for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/ides'].post
update:
x-apievangelist-phrasing:
intent: Create a Cloud IDE for an application
effect: write
questions:
- How do I spin up a new Cloud IDE for my application?
- Can I give a new Cloud IDE a custom label?
instructions:
- text: Create a Cloud IDE labeled {label} for application {applicationUuid}.
slots:
label: requestBody.label
applicationUuid: path.applicationUuid
- text: Provision a new IDE called {label} on application {applicationUuid}.
slots:
label: requestBody.label
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/messages'].get
update:
x-apievangelist-phrasing:
intent: List in-product messages for an application
effect: read
questions:
- What platform messages have been posted about my application?
- Can I filter an application's messages by message type or display mode?
instructions:
- text: List the messages for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show application {applicationUuid} messages between {from} and {to}.
slots:
applicationUuid: path.applicationUuid
from: query.from
to: query.to
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/notifications'].get
update:
x-apievangelist-phrasing:
intent: List work notifications for an application
effect: read
questions:
- What recent operations have been started on my application?
- Can I check the status of work items someone kicked off on an application?
instructions:
- text: List notifications for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show the latest {limit} notifications on application {applicationUuid}.
slots:
limit: query.limit
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/permissions'].get
update:
x-apievangelist-phrasing:
intent: List my permissions on an application
effect: read
questions:
- What am I allowed to do on this application?
- Which permissions do I hold for a given app?
instructions:
- text: List my permissions on application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show every permission I have for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/search'].get
update:
x-apievangelist-phrasing:
intent: Get the search entry point for an application
effect: read
questions:
- Where do the search-related endpoints for an application start?
- Is there a root link that leads to an application's search resources?
instructions:
- text: Get the search traversal links for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Open the search root endpoint of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/search/config-sets'].get
update:
x-apievangelist-phrasing:
intent: List search configuration sets for an application
effect: read
questions:
- Which search configuration sets does my application have?
- Can I see all the Solr config sets uploaded for an app?
instructions:
- text: List search configuration sets for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show every search config set on application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/search/config-sets'].post
update:
x-apievangelist-phrasing:
intent: Upload a search configuration set
effect: write
questions:
- How do I add a custom search configuration set to my application?
- Can I upload a search config archive for an app?
instructions:
- text: Create a search configuration set on application {applicationUuid} from archive {archive}.
slots:
applicationUuid: path.applicationUuid
archive: requestBody.archive
- text: Upload config archive {archive} as a new search config set for application {applicationUuid}.
slots:
archive: requestBody.archive
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/search/config-sets/{configurationSetId}'].get
update:
x-apievangelist-phrasing:
intent: Get one search configuration set
effect: read
questions:
- What's inside a specific search configuration set?
- Can I look up a single search config set by its ID?
instructions:
- text: Show search configuration set {configurationSetId} for application {applicationUuid}.
slots:
configurationSetId: path.configurationSetId
applicationUuid: path.applicationUuid
- text: Get config set {configurationSetId} from application {applicationUuid}.
slots:
configurationSetId: path.configurationSetId
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/search/config-sets/{configurationSetId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a search configuration set
effect: destructive
questions:
- Can I remove a search configuration set I no longer use?
- How do I delete an old search config set from an application?
instructions:
- text: Delete search configuration set {configurationSetId} from application {applicationUuid}.
slots:
configurationSetId: path.configurationSetId
applicationUuid: path.applicationUuid
- text: Remove config set {configurationSetId} on application {applicationUuid}.
slots:
configurationSetId: path.configurationSetId
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/settings'].get
update:
x-apievangelist-phrasing:
intent: Get the settings entry point for an application
effect: read
questions:
- What settings groups are available for an application?
- Is there a root link to navigate an application's settings sections?
instructions:
- text: Get the settings traversal links for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show which settings groups application {applicationUuid} exposes.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/settings/hosting'].get
update:
x-apievangelist-phrasing:
intent: Get an application's hosting settings
effect: read
questions:
- What hosting settings are configured for my application?
- Where can I check an app's hosting configuration?
instructions:
- text: Show the hosting settings of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Get hosting configuration for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/settings/keys'].get
update:
x-apievangelist-phrasing:
intent: Get an application's legacy product keys
effect: read
questions:
- Where do I find the legacy product keys for an application?
- Can I retrieve the old-style product keys tied to my app?
instructions:
- text: Show the legacy product keys for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Get application {applicationUuid}'s legacy keys.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/settings/ra'].get
update:
x-apievangelist-phrasing:
intent: Get remote administration settings
effect: read
questions:
- How is Remote Administration currently configured for my application?
- What update mode is my app's remote administration set to?
instructions:
- text: Show the remote administration settings of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Check the RA update configuration for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/settings/ra'].put
update:
x-apievangelist-phrasing:
intent: Change remote administration settings
effect: write
questions:
- Can I pause Remote Administration updates until a certain date?
- How do I set which environment RA deploys updates to and whether it copies the database?
instructions:
- text: Set remote administration for application {applicationUuid} to update mode {update_mode}.
slots:
applicationUuid: path.applicationUuid
update_mode: requestBody.update_mode
- text: Pause RA updates on application {applicationUuid} until {pause_until}, keeping mode {update_mode}.
slots:
applicationUuid: path.applicationUuid
pause_until: requestBody.pause_until
update_mode: requestBody.update_mode
- text: Have RA on application {applicationUuid} deploy to {deploy_environment} at {deploy_at} in {update_mode} mode.
slots:
applicationUuid: path.applicationUuid
deploy_environment: requestBody.deploy_environment
deploy_at: requestBody.deploy_at
update_mode: requestBody.update_mode
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/settings/security'].get
update:
x-apievangelist-phrasing:
intent: Get an application's security policy
effect: read
questions:
- Is two-factor authentication required on my application?
- Which IP addresses are allowed by an app's security policy?
instructions:
- text: Show the security policy settings of application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Check the allowed IPs and 2FA setting for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/settings/security'].put
update:
x-apievangelist-phrasing:
intent: Update an application's security policy
effect: write
questions:
- Can I require two-factor authentication for everyone on an application?
- How do I restrict an application to a list of allowed IP addresses?
instructions:
- text: 'Require 2FA on application {applicationUuid}: set tfa_required to {tfa_required}.'
slots:
applicationUuid: path.applicationUuid
tfa_required: requestBody.tfa_required
- text: Limit application {applicationUuid} access to IPs {allowed_ips}.
slots:
applicationUuid: path.applicationUuid
allowed_ips: requestBody.allowed_ips
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/tags'].get
update:
x-apievangelist-phrasing:
intent: List an application's tags
effect: read
questions:
- What tags have been applied to my application?
- Can I see the colored labels on an app?
instructions:
- text: List the tags on application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show application {applicationUuid}'s tags and colors.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/tags'].post
update:
x-apievangelist-phrasing:
intent: Add a tag to an application
effect: write
questions:
- How do I label an application with a colored tag?
- Can I pick the color when tagging an app?
instructions:
- text: Tag application {applicationUuid} with {name} in {color}.
slots:
applicationUuid: path.applicationUuid
name: requestBody.name
color: requestBody.color
- text: Create a {color} tag called {name} on application {applicationUuid}.
slots:
color: requestBody.color
name: requestBody.name
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/tags/{tagName}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a tag from an application
effect: destructive
questions:
- Can I delete a tag I put on an application by mistake?
- How do I take a label off an app?
instructions:
- text: Delete tag {tagName} from application {applicationUuid}.
slots:
tagName: path.tagName
applicationUuid: path.applicationUuid
- text: Remove the {tagName} label on application {applicationUuid}.
slots:
tagName: path.tagName
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/tasks'].get
update:
x-apievangelist-phrasing:
intent: List tasks run on an application
effect: read
questions:
- What tasks have been run against my application recently?
- Can I filter an application's task history?
instructions:
- text: List the tasks for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show application {applicationUuid} tasks matching {filter}.
slots:
applicationUuid: path.applicationUuid
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/teams'].get
update:
x-apievangelist-phrasing:
intent: List teams with access to an application
effect: read
questions:
- Which teams have access to this application?
- Can I search an app's teams by name?
instructions:
- text: List the teams assigned to application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Find teams on application {applicationUuid} matching {filter}.
slots:
applicationUuid: path.applicationUuid
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/metrics/usage'].get
update:
x-apievangelist-phrasing:
intent: Get usage metric links for an application
effect: read
questions:
- Where do I start to explore an application's views and visits metrics?
- What usage metric endpoints are available for one app?
instructions:
- text: Get the usage metric links for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show which usage reports exist for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/metrics/usage/data'].get
update:
x-apievangelist-phrasing:
intent: Get aggregate usage data for an application
effect: read
questions:
- How much traffic did my application get overall?
- Can I pull aggregate views or visits for an app at a daily resolution?
instructions:
- text: Get aggregate usage data for application {applicationUuid}.
slots:
applicationUuid: path.applicationUuid
- text: Show application {applicationUuid} usage filtered by {filter} at {resolution} resolution.
slots:
applicationUuid: path.applicationUuid
filter: query.filter
resolution: query.resolution
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/metrics/usage/data-by-environment'].get
update:
x-apievangelist-phrasing:
intent: Get application usage broken down by environment
effect: read
questions:
- Which environment of my application gets the most traffic?
- Can I compare usage across an app's environments side by side?
instructions:
- text: Break down usage for application {applicationUuid} by environment.
slots:
applicationUuid: path.applicationUuid
- text: Show per-environment usage for application {applicationUuid} with filter {filter}.
slots:
applicationUuid: path.applicationUuid
filter: query.filter
method: generated
generated: '2026-09-26'
- target: $.paths['/applications/{applicationUuid}/metrics/usage/{usageMetric}'].get
update:
x-apievangelist-phrasing:
intent: Get one usage metric for an application
effect: read
questions:
- What is the total for a single metric like visits on my app?
- Can I request just views or just visits for an application?
instructions:
- text: Get the {usageMetric} metric for application {applicationUuid}.
slots:
usageMetric: path.usageMetric
applicationUuid: path.applicationUuid
- text: Show aggregate {usageMetric} for application {applicationUuid} filtered by {filter}.
slots:
usageMetric: path.usageMetric
applicationUuid: path.applicationUuid
filter: query.filter
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/overlays/acquia-applications-api-phrasing-overlay.yaml