Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Analytics API

4 actions 4 updates phrasing extends openapi/apigee-analytics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Apigee's API. It is a proposal applied on top of the contract, not a document Apigee publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/organizations/{organizationId}/environments/{environmentId}/stats/{dimensionName}'].get

$.paths['/organizations/{organizationId}/analytics/datastores'].get

$.paths['/organizations/{organizationId}/analytics/datastores'].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 Apigee API Management Analytics API
  version: 1.0.0
extends: openapi/apigee-analytics-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: 3
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/stats/{dimensionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get traffic and latency stats for an environment
      effect: read
      questions:
      - How much traffic and how many errors did my API proxies see last week?
      - Can I break down proxy latency by a dimension over a time range?
      - Which proxies got the most requests in an environment?
      instructions:
      - text: Get {select} for environment {environmentId} in org {organizationId} by {dimensionName} over {timeRange}.
        slots:
          select: query.select
          environmentId: path.environmentId
          organizationId: path.organizationId
          dimensionName: path.dimensionName
          timeRange: query.timeRange
      - text: Show the top {topk} {dimensionName} by {select} in {environmentId}, org {organizationId}, for {timeRange} per {timeUnit}.
        slots:
          topk: query.topk
          dimensionName: path.dimensionName
          select: query.select
          environmentId: path.environmentId
          organizationId: path.organizationId
          timeRange: query.timeRange
          timeUnit: query.timeUnit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/analytics/datastores'].get
  update:
    x-apievangelist-phrasing:
      intent: List analytics export data stores
      effect: read
      questions:
      - Where can my analytics data be exported to?
      - Which analytics data stores are configured for my org?
      instructions:
      - text: List analytics data stores in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show the export destinations for analytics in org {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/analytics/datastores'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an analytics export data store
      effect: write
      questions:
      - How do I set up a destination for exporting Apigee analytics data?
      - Can I choose the target type for an analytics export store?
      instructions:
      - text: Create an analytics data store named {displayName} in organization {organizationId}.
        slots:
          displayName: requestBody.displayName
          organizationId: path.organizationId
      - text: Add an analytics export store {displayName} of type {targetType} with config {datastoreConfig} in org {organizationId}.
        slots:
          displayName: requestBody.displayName
          targetType: requestBody.targetType
          datastoreConfig: requestBody.datastoreConfig
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'