OneSignal · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Onesignal Players API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/players/csv_export'].post
$.paths['/players/csv_export?app_id={app_id}'].post

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 Onesignal Players API
  version: 1.0.0
extends: openapi/onesignal-players-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: 2
- target: $.paths['/players/csv_export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export subscriptions to a CSV file
      effect: read
      questions:
      - How do I download all my subscription data as a CSV?
      - Can I include unsubscribed records in a subscription export?
      instructions:
      - text: Export the subscriptions of app {app_id} to CSV.
        slots:
          app_id: query.app_id
      - text: Export subscriptions in segment {segment_name} for app {app_id}, including unsubscribed ones.
        slots:
          segment_name: requestBody.segment_name
          app_id: query.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/players/csv_export?app_id={app_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Export all user data to CSV (legacy endpoint)
      effect: read
      questions:
      - Is there an older, faster alternative to paging through every user record?
      - Which legacy call exports users active since a certain time?
      instructions:
      - text: Run the legacy user-data CSV export for app {app_id}.
        slots:
          app_id: path.app_id
      - text: Use the older export for app {app_id} limited to users active since {last_active_since}.
        slots:
          app_id: path.app_id
          last_active_since: requestBody.last_active_since
      method: generated
      generated: '2026-09-26'