# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bitly Organizations API
  version: 1.0.0
extends: openapi/bitly-organizations-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: 5
- target: $.paths['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organizations
      effect: read
      questions:
      - Which Bitly organizations do I belong to?
      - Can I see organizations my token is not scoped to as well?
      instructions:
      - text: List the organizations my token can access.
      - text: List all of my organizations, including ones outside the token's allowed orgs, with include_all set to {include_all}.
        slots:
          include_all: query.include_all
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_guid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details
      effect: read
      questions:
      - How do I look up the details of one organization by its GUID?
      - What tier and name does a particular organization have?
      instructions:
      - text: Show the details of organization {organization_guid}.
        slots:
          organization_guid: path.organization_guid
      - text: Fetch organization {organization_guid}.
        slots:
          organization_guid: path.organization_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_guid}/shorten_counts'].get
  update:
    x-apievangelist-phrasing:
      intent: Count links shortened by an organization over time
      effect: read
      questions:
      - How many links has my whole organization shortened over the last few months?
      - Can I see an organization's shortening volume broken out by day or week?
      instructions:
      - text: Show how many links organization {organization_guid} shortened over the last {units} {unit}s.
        slots:
          organization_guid: path.organization_guid
          units: query.units
          unit: query.unit
      - text: Get organization {organization_guid}'s shorten counts per {unit} for all time.
        slots:
          organization_guid: path.organization_guid
          unit: query.unit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_guid}/shorten_counts_by_group'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down an organization's shortens by group this month
      effect: read
      questions:
      - Which groups in my organization are shortening the most links this month?
      - Can I split this month's organization shorten count across its groups?
      instructions:
      - text: Break down this month's shortened links for organization {organization_guid} by group.
        slots:
          organization_guid: path.organization_guid
      - text: Show per-group shorten counts for the current month in organization {organization_guid}.
        slots:
          organization_guid: path.organization_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_guid}/plan_limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an organization's plan limits
      effect: read
      questions:
      - How close is my organization to its plan's link and QR code limits?
      - What does our subscription plan allow, and how much of it have we used?
      instructions:
      - text: Show the plan limits and current counts for organization {organization_guid}.
        slots:
          organization_guid: path.organization_guid
      - text: Check how much of its plan allowance organization {organization_guid} has used.
        slots:
          organization_guid: path.organization_guid
      method: generated
      generated: '2026-09-26'