AppsFlyer · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Engagements Click Engagement API

3 actions 3 updates phrasing extends openapi/appsflyer-click-engagement-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/click/app/{platform}/{app_id}'].get

$.paths['/click/app/{platform}/{app_id}'].post

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 Engagements Click Engagement API
  version: 1.0.0
extends: openapi/appsflyer-click-engagement-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['/click/app/{platform}/{app_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Report a click engagement via GET
      effect: write
      questions:
      - How do I send a click to AppsFlyer as a query-string GET request?
      - Which parameters are required to report an ad click by URL?
      instructions:
      - text: Report a click for {app} on {platform} from media source {media_source} campaign {campaign} using the GET form.
        slots:
          app: path.app_id
          platform: path.platform
          media_source: query.af_media_source
          campaign: query.af_campaign_id
      - text: Send a GET click for {app} on {platform} with click ID {click_id}, source {media_source}, campaign {campaign}.
        slots:
          app: path.app_id
          platform: path.platform
          click_id: query.af_click_id
          media_source: query.af_media_source
          campaign: query.af_campaign_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/click/app/{platform}/{app_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a click engagement via POST body
      effect: write
      questions:
      - Can I report ad clicks server to server with a JSON body?
      - Can a posted click carry custom parameters and a lookback window?
      instructions:
      - text: Post a click for {app} on {platform} from {media_source} campaign {campaign} in the request body.
        slots:
          app: path.app_id
          platform: path.platform
          media_source: requestBody.af_media_source
          campaign: requestBody.af_campaign_id
      - text: Post a click body for {app} on {platform}, source {media_source}, campaign {campaign}, lookback {lookback}.
        slots:
          app: path.app_id
          platform: path.platform
          media_source: requestBody.af_media_source
          campaign: requestBody.af_campaign_id
          lookback: requestBody.af_lookback_window
      method: generated
      generated: '2026-10-01'