Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agorapulse Reports API

4 actions 4 updates phrasing extends openapi/agorapulse-reports-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Agorapulse's API. It is a proposal applied on top of the contract, not a document Agorapulse publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/audience'].get
$.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/communitymanagement'].get
$.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/content'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Agorapulse Reports API
  version: 1.0.0
extends: openapi/agorapulse-reports-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['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/audience'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a profile's audience report
      effect: read
      questions:
      - How has my profile's audience and follower count changed over a period?
      - What audience growth data can I pull for a social profile?
      instructions:
      - text: Get the audience report for profile {profile} from {since} to {until} in workspace {workspace}, org {org}.
        slots:
          profile: path.profileUid
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      - text: Show follower growth for profile {profile} between {since} and {until} (workspace {workspace}, org {org}).
        slots:
          profile: path.profileUid
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/communitymanagement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a community management report
      effect: read
      questions:
      - How quickly and how often did my team respond to comments and messages on a profile?
      - Can I get community management stats for a social profile over a date range?
      instructions:
      - text: Get the community management report for profile {profile} from {since} to {until} in workspace {workspace}, org {org}.
        slots:
          profile: path.profileUid
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      - text: Show inbox engagement and response activity for profile {profile} between {since} and {until} (workspace {workspace}, org {org}).
        slots:
          profile: path.profileUid
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/insights/content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a content performance report
      effect: read
      questions:
      - Which of my published posts performed best on a profile last month?
      - What does the content report show about post performance?
      instructions:
      - text: Get the content report for profile {profile} from {since} to {until} in workspace {workspace}, org {org}.
        slots:
          profile: path.profileUid
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      - text: Show how posts on profile {profile} performed between {since} and {until} (workspace {workspace}, org {org}).
        slots:
          profile: path.profileUid
          since: query.since
          until: query.until
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'