Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agorapulse Competitor API

3 actions 3 updates phrasing extends openapi/agorapulse-competitor-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 3

$.info

$.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/competitors'].get

$.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/competitors/insights'].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 Agorapulse Competitor API
  version: 1.0.0
extends: openapi/agorapulse-competitor-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: 2
- target: $.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/competitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List competitors tracked for a profile
      effect: read
      questions:
      - Which competitors am I tracking for my Facebook page in Agorapulse?
      - Can I see the competitor accounts set up for an Instagram business profile?
      - Is competitor tracking available for profiles other than Facebook and Instagram?
      instructions:
      - text: List the competitors tracked for profile {profile} in workspace {workspace}, org {org}.
        slots:
          profile: path.profileUid
          workspace: path.workspaceId
          org: path.organizationId
      - text: Show who profile {profile} is benchmarked against in workspace {workspace} of org {org}.
        slots:
          profile: path.profileUid
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/report/organizations/{organizationId}/workspaces/{workspaceId}/profiles/{profileUid}/competitors/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a competitor benchmark report
      effect: read
      questions:
      - How does my Instagram account's performance compare with the competitors I track?
      - What does the aggregated competitor report show for a date range?
      - How fresh is competitor data, and is it synced daily?
      instructions:
      - text: Get the competitor report for profile {profile} in workspace {workspace}, org {org} from {since} to {until}.
        slots:
          profile: path.profileUid
          workspace: path.workspaceId
          org: path.organizationId
          since: query.since
          until: query.until
      - text: Compare profile {profile} against its tracked competitors 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'