MoEngage · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MoEngage Analytics Dashboard and Chart Dashboards API

4 actions 4 updates phrasing extends openapi/moengage-dashboards-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v5/analytics/dashboards'].get

$.paths['/v5/analytics/dashboards/{dashboard_id}/charts'].get

$.paths['/v5/analytics/dashboards/{dashboard_id}/charts/{chart_id}'].get

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 MoEngage Analytics Dashboard and Chart Dashboards API
  version: 1.0.0
extends: openapi/moengage-dashboards-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['/v5/analytics/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom analytics dashboards
      effect: read
      questions:
      - What custom analytics dashboards does my workspace have?
      - Are archived dashboards included when I list dashboards?
      instructions:
      - text: List my analytics dashboards.
      - text: Show every non-archived custom dashboard in this workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/analytics/dashboards/{dashboard_id}/charts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the charts on a dashboard
      effect: read
      questions:
      - Which charts are on a particular dashboard, and who owns it?
      - How do I get chart IDs from a dashboard in layout order?
      instructions:
      - text: List the charts on dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboard_id
      - text: Show the owner and chart layout of dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboard_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/analytics/dashboards/{dashboard_id}/charts/{chart_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the data behind a chart
      effect: read
      questions:
      - How do I pull the underlying rows for a single dashboard chart?
      - Can I force a fresh query instead of cached results for a chart?
      instructions:
      - text: Get the data for chart {chart_id} on dashboard {dashboard_id}.
        slots:
          chart_id: path.chart_id
          dashboard_id: path.dashboard_id
      - text: Rerun chart {chart_id} in dashboard {dashboard_id} with cache set to {cache}.
        slots:
          chart_id: path.chart_id
          dashboard_id: path.dashboard_id
          cache: query.cache
      method: generated
      generated: '2026-10-01'