# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Meltwater Owned Analytics API
  version: 1.0.0
extends: openapi/meltwater-owned-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: 7
- target: $.paths['/v3/owned/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List connected social accounts
      effect: read
      questions:
      - Which owned social accounts are connected to my company?
      - How do I find the account IDs I need for owned social metrics?
      instructions:
      - text: List my connected social accounts.
      - text: Show the social account connections for company {company_id}.
        slots:
          company_id: query.company_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/owned/accounts/metrics/breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down an owned account metric by category
      effect: read
      questions:
      - What countries does my Facebook page audience come from?
      - Can I split an owned-account metric by a single category like country?
      instructions:
      - text: Break down {metrics} for {source} accounts {account_ids} from {start} to {end}.
        slots:
          metrics: query.metrics
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
      - text: Show the audience-by-country split for {source} account {account_ids} using {metrics}, {start} to {end}.
        slots:
          source: query.source
          account_ids: query.account_ids
          metrics: query.metrics
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/owned/accounts/metrics/heatmap'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a day-and-hour heatmap for an owned account
      effect: read
      questions:
      - When during the week is my page audience most active?
      - Can I see an owned-account metric broken out by day and hour?
      instructions:
      - text: Get the day-and-hour heatmap of {metrics} for {source} accounts {account_ids} from {start} to {end}.
        slots:
          metrics: query.metrics
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
      - text: Show when followers of {source} account {account_ids} are most active, {start} to {end}, metric {metrics}.
        slots:
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
          metrics: query.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/owned/accounts/metrics/nested_breakdown'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down an owned account metric two levels deep
      effect: read
      questions:
      - How is my page audience split by gender and then by age group?
      - Can I get a two-level breakdown of an owned social metric?
      instructions:
      - text: Get the nested two-level breakdown of {metrics} for {source} accounts {account_ids} from {start} to {end}.
        slots:
          metrics: query.metrics
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
      - text: Show the gender-then-age audience split for {source} account {account_ids}, {start} to {end}, using {metrics}.
        slots:
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
          metrics: query.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/owned/accounts/metrics/numeric'].get
  update:
    x-apievangelist-phrasing:
      intent: Get simple numeric metrics for an owned account
      effect: read
      questions:
      - How many fans does my page have right now?
      - Can I pull basic counts for up to ten owned social accounts at once?
      instructions:
      - text: Get numeric metrics {metrics} for {source} accounts {account_ids} from {start} to {end}.
        slots:
          metrics: query.metrics
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
      - text: Show the page fan count for {source} account {account_ids} between {start} and {end} using {metrics}.
        slots:
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
          metrics: query.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/owned/accounts/posts/top_posts'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the top posts on owned social accounts
      effect: read
      questions:
      - Which of my own posts got the most engagement last month?
      - Can I filter my top posts by post type or tag?
      instructions:
      - text: List the top posts for {source} accounts {account_ids} from {start} to {end}.
        slots:
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
      - text: Show my most engaging {post_types} posts on {source} account {account_ids}, {start} to {end}, sorted by {sort_by}.
        slots:
          post_types: query.post_types
          source: query.source
          account_ids: query.account_ids
          start: query.start
          end: query.end
          sort_by: query.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/owned/supported_metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported owned social metrics
      effect: read
      questions:
      - Which metric IDs can I request for my owned social accounts?
      - What owned-analytics metrics are supported?
      instructions:
      - text: List the supported owned social metrics.
      - text: Show every metric ID I can use for owned account analytics.
      method: generated
      generated: '2026-10-01'